diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml new file mode 100644 index 0000000..d48b3d7 --- /dev/null +++ b/.github/workflows/pr.yml @@ -0,0 +1,137 @@ +name: Generate JSON and Save as Artifacts + +on: + pull_request: + types: + - opened + - reopened + - synchronize + - closed + push: + tags: + - "*" + +jobs: + build: + name: generate-json-and-save-as-artifacts + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: install node + uses: actions/setup-node@v4 + with: + node-version: 20 + registry-url: https://npm.pkg.github.com + + - name: Install package from npm registry + run: | + echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > .npmrc + npm install + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.x" + + - name: install requirements.txt + run: pip install -r requirements.txt + + - name: Copy HTML file + run: cp -r node_modules/@tektronix/web-help-documents web-help-documents + + - name: Run Python script to generate JSON + run: python main.py web-help-documents + + - name: Archive artifacts + uses: actions/upload-artifact@v4 + with: + name: generated-json + path: data/ + release: + name: Release + runs-on: ubuntu-latest + permissions: + contents: write + checks: write + pull-requests: read + needs: + - build + if: ${{ (endsWith(github.base_ref, 'main') && (contains(github.head_ref, 'release/')) || github.event.pull_request.merged ) }} + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 + fetch-tags: true + - name: Get RC Version + id: lasttag + run: | + COMMIT="${{github.sha}}" + if ${{contains(github.head_ref, 'release/')}}; then + V="${{github.head_ref}}" + V="${V#release/}" + else + V="$(npm pkg get version)" + echo "Extracted Version: $V" + V="$(echo v"$V" | sed 's/\"//g')" + echo "Cleaned up Version: $V" + fi + + # Check to see if the version tag already exists + # If it does, print a message and exit with an error code + if [ $(git tag --list "$V") ]; then + echo "Version tag already exists. Did you bump the version number?" + exit 1 + fi + + # Create an RC release if + # 1) This PR is a release branch that hasn't been merged to main. + # 2) This is a feature branch being merged into the main branch. + if ${{(! github.event.pull_request.merged && contains(github.head_ref, 'release/')) || (github.event.pull_request.merged && !contains(github.head_ref, 'release/'))}}; then + V="${V}-$(git tag --list ${V}* | wc -l)" + echo "RC Version: $V" + fi + + CL=${V#v} + CL=${CL%-*} + + echo "version=${V}" >> $GITHUB_OUTPUT + echo "cl_version=${CL}" >> $GITHUB_OUTPUT + echo "commit=${COMMIT}" >> $GITHUB_OUTPUT + + - run: 'git tag --list ${V}*' + - name: Get Artifacts + uses: actions/download-artifact@v3 + with: + name: generated-json + path: data/ + - name: Get Changelog for this Tag + id: changelog + uses: coditory/changelog-parser@v1 + with: + version: ${{steps.lasttag.outputs.cl_version}} + - name: Create Release + uses: ncipollo/release-action@v1 + with: + name: ${{steps.lasttag.outputs.version}} + artifacts: "extension/*.vsix,sbom/**/*" + body: | + ## Features Requests / Bugs + + If you find issues or have a feature request, please enter a [new issue on GitHub](${{github.server_url}}/${{github.repository}}/issues/new). + + ## Installation + + View the installation instructions in the [README](${{github.server_url}}/${{github.repository}}/blob/main/README.md) + + ## Changelog + + ${{steps.changelog.outputs.description}} + + prerelease: ${{ (! github.event.pull_request.merged) || (github.event.pull_request.merged && ! contains(github.head_ref, 'release/')) }} + commit: ${{steps.lasttag.outputs.commit}} + makeLatest: true + tag: ${{steps.lasttag.outputs.version}} \ No newline at end of file diff --git a/.gitignore b/.gitignore index 5d70c70..f84f672 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ -**/*.pyc \ No newline at end of file +**/*.pyc +node_modules/ +.vscode/ +data/ diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..c897e15 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +@tektronix:registry=https://npm.pkg.github.com \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 832113d..4d92b86 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,7 +16,11 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how Security -- in case of vulnerabilities. --> -## [Unreleased] +## [0.15.1] + +### Changed +- workflow has been added for generaing json artifacts. -[Unreleased]: https://github.com/tektronix/tsp-toolkit-webhelp-to-json/tree/dev +[Unreleased]: https://github.com/tektronix/tsp-toolkit-webhelp-to-json/compare/v0.15.1...HEAD +[0.15.1]: https://github.com/tektronix/tsp-toolkit-webhelp-to-json/releases/tag/v0.15.1 diff --git a/Configuration.py b/Configuration.py index 215f00f..81b78e9 100644 --- a/Configuration.py +++ b/Configuration.py @@ -1,15 +1,33 @@ # Folder path of webhelp file import os +class Confiurations: + HELP_FILE_FOLDER_PATH = "C:\\Users\\rjha\\source\\repos\\GitHub\\tsp-toolkit-webhelp\\WebHelpDocs\\Commands_DMM7510\\" -HELP_FILE_FOLDER_PATH = "C:\\Users\\rjha\\source\\repos\\GitHub\\tsp-toolkit-webhelp\\WebHelpDocs\\Commands_DMM7510\\" + # model number + MODEL_NUMBER = "DMM7510" -# model number -MODEL_NUMBER = "DMM7510" + # Currently ist only get used for 26xx models + CHANNELS = ['a'] -# Currently ist only get used for 26xx models -CHANNELS = ['a'] + # folder path where generated json file will store + OUTPUT_FOLDER_PATH = os.path.join(os.getcwd(), "data") -# folder path where generated json file will store - -OUTPUT_FOLDER_PATH = os.getcwd()+ "\\data" \ No newline at end of file + SUPPORTED_MODELS = ["2450", + "2460", + "2461", + "2470", + "DMM7510", + "26XX" + ] + + MODEL_2600B_CHANNELS= {"2601B":["a"], + "2611B":["a"], + "2635B": ["a"], + "2604B": ["a", "b"], + "2614B": ["a", "b"], + "2602B": ["a", "b"], + "2612B": ["a", "b"], + "2634B": ["a", "b"], + "2636B": ["a", "b"] + } \ No newline at end of file diff --git a/ParserGeneric/HelperFunctions.py b/ParserGeneric/HelperFunctions.py index 64fbf48..6d83100 100644 --- a/ParserGeneric/HelperFunctions.py +++ b/ParserGeneric/HelperFunctions.py @@ -3,7 +3,7 @@ import re from bs4 import BeautifulSoup from ordered_set import OrderedSet -from Configuration import MODEL_NUMBER +from Configuration import Confiurations from helpers import cmd_param supportedInstruments = "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L" @@ -109,7 +109,7 @@ def get_record(name, webhelpfile, cmd_type, default_value, descr, details, param record["usage"] = usage record["overloads"] = list(overloads) record["examples"] = example - if(str(MODEL_NUMBER).find("26")!= -1): + if(str(Confiurations.MODEL_NUMBER).find("26")!= -1): if flag == 1: record["supported_models"] = temp_c else: @@ -269,7 +269,7 @@ def get_parameter_details(S, command_name): param_desc = "\n".join([item.get_text(separator='\n') for item in data[1:]]) #24xx, dmm, daq - if(str(MODEL_NUMBER).find("26")!= -1): + if(str(Confiurations.MODEL_NUMBER).find("26")!= -1): param_desc = "\n".join([item.get_text().replace("\n", "") for item in data[1:]]) @@ -434,9 +434,9 @@ def get_param_type(cmd, param_name) -> str: if str(cmd).startswith("status.") and "*" in cmd: return "number" - file_path = "ParserGeneric\\tti-command_param_data_type.txt" - if(str(MODEL_NUMBER).find("26")!= -1): - file_path = "ParserGeneric\\26xx-command_param_data_type.txt" + file_path = os.path.join("ParserGeneric","tti-command_param_data_type.txt") + if(str(Confiurations.MODEL_NUMBER).find("26")!= -1): + file_path = os.path.join("ParserGeneric","26xx-command_param_data_type.txt") paramTypeDetails = cmd_param.getParamTypeDetails( os.path.abspath(file_path)) diff --git a/data/2450.json b/data/2450.json deleted file mode 100644 index 925f88c..0000000 --- a/data/2450.json +++ /dev/null @@ -1,15119 +0,0 @@ -{ - "commands": [ - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double-beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - }, - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user-defined string catalog.", - "details": "The catalog provides access for user-defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user-defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key-value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user-defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user-defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user-defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "upgrade.previous()", - "webhelpfile": "14062.htm", - "signature": "upgrade.previous()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns to a previous version of the Model 2450 firmware.", - "details": "This function allows you to revert to an earlier version of the firmware.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument performs the upgrade. An error is returned if an upgrade file is not found.", - "param_info": [], - "usage": [ - "upgrade.previous()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "Upgrading the firmware", - "upgrade.unit()" - ] - }, - { - "name": "upgrade.unit()", - "webhelpfile": "14063.htm", - "signature": "upgrade.unit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function upgrades the Model 2450 firmware.", - "details": "When upgrade.unit() is used, the firmware is only loaded if the version of the firmware is newer than the existing version. If the version is older or at the same revision level, it is not upgraded.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument verifies that the file is a newer version. If the version is older or at the same revision level, it is not upgraded, although it does request a reboot. If it is a newer version, the instrument performs the upgrade. An error event message is returned if no upgrade file is found.", - "param_info": [], - "usage": [ - "upgrade.unit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "upgrade.previous()", - "Upgrading the firmware" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));\u00a0;\u00a0;\u00a0;tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP-enabled. The Model 2450 does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP-enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP-enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2450 sends an abort command to the remote device on connection. The Model 2450 also enables TSP prompts on the remote device and event management. The Model 2450 places remote errors and events from the TSP-enabled device in its own event queue and prefaces these events with Remote Error, followed by an event description. Do not manually change either the prompt functionality (localnode.prompts) or show events by changing localnode.showerrors or localnode.showevents on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP-enabled.\n" - } - ], - "related_commands": [ - "localnode.prompts", - "localnode.showevents", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP-Net session.\n--- --\u00a0\n--- --Close the session.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2450 decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the Model 2450 suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The Model 2450 places any remotely generated errors and events into its event queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear as:\n--- --KEITHLEY INSTRUMENTS,MODEL 2450,00000170,1.1.0s\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the Model 2450 pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the Model 2450 reads from a TSP-enabled remote instrument, the Model 2450 removes Test Script Processor (TSP\u00ae) prompts and places any errors or events it receives from the remote instrument into its own event queue. The Model 2450 prefaces events and errors from the remote device with Remote Error, followed by the event number and description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");\u00a0;repeat bytes = tspnet.readavailable(ID) until bytes > 0;\u00a0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that will create data.\n--- --\u00a0\n--- --Wait for data to be available.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands. ", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands will wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP-enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP-enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP-enabled instrument.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The Model 2450 sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma-delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "times = tspnet.tsp.rbtablecopy(testTspdevice,; \"testRemotebuffername.timestamps\", 1, 3);print(times);", - "description": "Copy the specified timestamps table for items 1 through 3, then display the table. Example output:\n--- --01/01/2015 10:10:10.0000013,01/01/2015 10:10:10.0000233,01/01/2015 10:10:10.0000576\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount | integer", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newpath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newpath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "18\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "15009.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts on a remote TSP-Link node. ", - "details": "This command is only applicable to TSP-Link systems. You can use this command to use the remote master node to run a script on the specified node. This function does not run test scripts on the master node; only on the subordinate node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x = 5\") to set x equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "related_commands": [ - "tsplink.group" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. ", - "details": "This function retrieves the value of a global variable from the run-time environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "related_commands": [ - "node[N].setglobal()" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2450 \n" - } - ], - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. ", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "related_commands": [ - "node[N].getglobal()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "15057.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex is set to less than 1 or if endIndex is more than the size of the index, 9.910000e+37 is returned for each value outside the allowed index and an event is generated.If overlapped commands use the specified reading buffers and the commands are not complete (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the readings have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data.The output of printbuffer() is affected by the data format selected by format.data. If you set format.data to format.REAL32 or format.REAL64, you have fewer options for buffer elements. With these formats, the only buffer elements available are readings, relativetimestamps, and extravalues. If you request a buffer element that is not permitted for the selected data format, the instrument returns 9.91e37.You can use the bufferVar attributes that are listed in the following table with the print buffer command. For example, if testData is the buffer, you can use testData.dates attribute to print the date of each reading in the testData buffer.You can use bufferVar.n to retrieve the number of readings in the specified reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "Name of first table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(200);format.data = format.ASCII;format.asciiprecision = 6;trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.readings, testData.units, testData.relativetimestamps);", - "description": "Reset the instrument.\n--- --Set the data format and ASCII precision.\n--- --Use trigger model SimpleLoop to create a 6-count loop with no delays that stores data in the reading buffer testBuffer.\n--- --Start the trigger model, wait for the commands to complete, and output the readings.\n--- --Use of testData.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, testBuffer.n equals 6.\n--- --Example of output data: \n--- --1.10458e-11, Amp DC, 0.00000e+00, 1.19908e-11, Amp DC, 1.01858e-01, 1.19908e-11, Amp DC, 2.03718e-01, 1.20325e-11, Amp DC, 3.05581e-01, 1.20603e-11, Amp DC, 4.07440e-01, 1.20325e-11, Amp DC, 5.09299e-01\n" - }, - { - "example": "for x = 1, testData.n do; printbuffer(x,x,testData, testData.units, testData.relativetimestamps);end;", - "description": "Using the same buffer created in Example 1, output the readings, units and relative timestamps on a separate line for each reading.\n--- --1.10458e-11, Amp DC, 0.00000e+00\n--- --1.19908e-11, Amp DC, 1.01858e-01\n--- --1.19908e-11, Amp DC, 2.03718e-01\n--- --1.20325e-11, Amp DC, 3.05581e-01\n--- --1.20603e-11, Amp DC, 4.07440e-01\n--- --1.20325e-11, Amp DC, 5.09299e-01\n" - } - ], - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP-Link node. ", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "2\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. ", - "details": "This command sets the TSP-Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP-Link instrument or tsplink.initialize() is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP-Link node for this instrument to number\u00a03.\n" - } - ], - "related_commands": [ - "tsplink.initialize() ", - "tsplink.state" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. ", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "related_commands": [ - "Triggering using TSP-Link trigger lines", - "tsplink.line[N].state", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP-Link online state. ", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.initialize() or tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "\"online\" | \"offline\"", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP-Link system. If it is online, the output is:\n--- --online\n" - } - ], - "related_commands": [ - "tsplink.initialize()", - "tsplink.node" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP-Link synchronization lines as a digital I/O port. ", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "related_commands": [ - "tsplink.line[N].state" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean | true | false", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that will be used the next time the timer is triggered.If you use the trigger timer with a trigger model, make sure the trigger timer delay is set so that the readings are paced correctly.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (8 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(8 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be >=\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};\u00a0;DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --\u00a0\n--- --Read the delay list on trigger timer\u00a03.\n--- --\u00a0\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event or is enabled as a timer or alarm.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - }, - { - "example": "reset();trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;\u00a0;trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY8);trigger.model.setblock(3, trigger.BLOCK_WAIT, trigger.EVENT_TIMER4);trigger.model.setblock(4, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 20, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the trigger timer 4 stimulus to off.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n--- --\u00a0\n--- --Clear the trigger model.\n--- --Set trigger model block 1 to clear the buffer.\n--- --Set trigger model block 2 to generate the notify 8 event.\n--- --Set trigger model block 3 to wait for the trigger timer 4 to occur.\n--- --Set trigger model block 4 to make a measurement and store it in default buffer 1.\n--- --Set trigger model block 5 to repeat the trigger model 20 times, starting at block 3.\n--- --Start the trigger model.\n--- --Wait until all commands are complete.\n--- --Print the number of entries in default buffer 1.\n--- --\u00a0\n--- --Output:\n--- --20\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified, the script is saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.If you set scriptVar to autoexec, the script is run when the instrument powers up. You must delete the existing autoexec script before saving the new one. Note that performing a system reset does not delete the autoexec script.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB flash drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "related_commands": [ - "Working with scripts" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "smu.measure.func", - "webhelpfile": "25622.htm", - "signature": "", - "command_return": "mFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_CURRENT\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the active measure function.", - "details": "Set this command to the type of measurement you want to make.Reading this command returns the measure function that is presently active.When you select a function, settings for other commands that are related to the function become active. For example, assume that:If you return to the current function, the math function returns to reciprocal. If you then switch from the current function to the voltage function, the math function returns to percent. All attributes that begin with smu.measure. are saved with the active measure function unless otherwise indicated in the command description.", - "param_info": [ - { - "name": "mFunction", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefuncmFunction", - "range": "" - } - ], - "usage": [ - "mFunction = smu.measure.func", - "smu.measure.func = mFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;print(smu.measure.math.format);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.math.format);", - "description": "Sets the instrument to measure voltage and set the math format to percent and enable the math functions.\n--- --Set the instrument to measure resistance and set the math format to reciprocal and enable the math functions.\n--- --Print the math format while the resistance measurement function is selected. The output is:\n--- --smu.MATH_RECIPROCAL\n--- --Change the function to voltage. Print the math format. The output is:\n--- --smu.MATH_PERCENT\n" - } - ], - "related_commands": [ - "Source and measure using TSP commands" - ] - }, - { - "name": "buffer.getstats()", - "webhelpfile": "25624.htm", - "signature": "buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "command_return": "statsVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns statistics from a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that was placed in the reading buffer.The instrument automatically updates reading buffer statistics as data is added to the reading buffer.When the reading buffer is configured to fill continuously and overwrite old data with new data, the buffer statistics include the data that was overwritten. To get statistics that do not include data that has been overwritten, define a large buffer size that will accommodate the number of readings you will make. The table returned from this function provides statistics at the time the function is called. Although the instrument continues to update the statistics, the table that is returned is not updated. To get fresh statistics, call this function again.The statsVar parameter contains the values described in the following table.If n equals zero (0), all other values are nil. If n equals 1, stddev is nil because the standard deviation of a sample size of 1 is undefined.Use the following command to get values from statsVar; a table with the following entries in it: n, min, max, mean, and stddev:Use the following commands to print these entries:", - "param_info": [ - { - "name": "statsVar", - "description": "A table that contains the entries for buffer statistics; see Details for information on the entries", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "absStartTime", - "description": "An integer that represents the absolute start time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absStartFractional", - "description": "An integer that represents the portion of the absolute start time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndTime", - "description": "An integer that represents the absolute end time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndFractional", - "description": "An integer that represents the portion of the absolute end time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relStartTime", - "description": "The start time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relEndTime", - "description": "The end time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "overloads": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 12, 0.001, defbuffer1);trigger.model.initiate();waitcomplete();\u00a0;stats = buffer.getstats(defbuffer1);print(stats);", - "description": "Reset the instrument.\n--- --Set up the SimpleLoop trigger-model template to make 12 readings with a 0.001\u00a0s delay. Readings are stored in defbuffer1.\n--- --Start the trigger model.\n--- --Assign the name stats to the table.\n--- --Get statistics for the default reading buffer named defbuffer1.\n--- --Example output:\n--- --[\"min\"]={[\"seconds\"]=1561123956, [\"fractionalseconds\"]=0.010184587, [\"timestamp\"]=1561123956, [\"reading\"]=8.4974199416e-05}, [\"mean\"]=0.000132948335, [\"stddev\"]=4.4270141937e-05, [\"max\"]={[\"seconds\"]=1561123955, [\"fractionalseconds\"]=0.833083981, [\"timestamp\"]=1561123955.8, [\"reading\"]=0.0002192359033}, [\"n\"]=12\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.model.abort()", - "webhelpfile": "25628.htm", - "signature": "trigger.model.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stops all trigger model commands on the instrument.", - "details": "When this command is received, the instrument stops the trigger model.", - "param_info": [ - { - "name": "trigger.model.abort()", - "description": "Terminates all commands related to the trigger model on the instrument.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.abort();", - "description": "Terminates all commands related to the trigger model on the instrument.\n" - } - ], - "related_commands": [ - "Effect of GPIB line events on Model 2450", - "Aborting the trigger model" - ] - }, - { - "name": "buffer.make()", - "webhelpfile": "25629.htm", - "signature": "buffer.make(bufferSize, style)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a user-defined reading buffer.", - "details": "You cannot assign user-defined reading buffers the name defbuffer1 or defbuffer2. In addition, the buffer name must not already exist as a global variable, a local variable, table, or array.If you create a reading buffer that has the same name as an existing user-defined buffer, the existing buffer is overwritten by the new buffer. Any data in the existing buffer is lost.When you create a reading buffer, it becomes the active buffer. If you create two reading buffers, the last one you create becomes the active buffer.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.The default fill mode of a user-defined buffer is once. You can change it to continuous later.Once the buffer style is selected, it cannot be changed.Once you store the first reading in a compact buffer, you cannot change certain measurement settings, including range, display digits, and units; you must clear the buffer first.Not all remote commands are compatible with the compact, writable, and full writable buffer styles. Check the Details section of the command descriptions before using them with any of these buffer styles.Writable reading buffers are used to bring external data into the instrument. You cannot assign them to collect data from the instrument.You can change the buffer capacity for an existing buffer through the front panel or by using the bufferVar.capacity command.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferSize", - "description": "The maximum number of readings that can be stored in bufferVar; minimum is\u00a010; 0 to maximize buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "style", - "description": "The type of reading buffer to create", - "enum": "buffer.STYLE_COMPACT nil|buffer.STYLE_STANDARD nil|buffer.STYLE_FULL nil|buffer.STYLE_WRITABLE nil|buffer.STYLE_WRITABLE_FULL nil", - "type": "buffermakestyle", - "range": "" - } - ], - "usage": [ - "bufferVar = buffer.make(bufferSize)", - "bufferVar = buffer.make(bufferSize, style)" - ], - "overloads": [ - "bufferVar = buffer.make(bufferSize)" - ], - "examples": [ - { - "example": "capTest2\u00a0= buffer.make(200, buffer.STYLE_FULL);", - "description": "Creates a 200-element reading buffer that stores readings with full accuracy named capTest2.\n" - } - ], - "related_commands": [ - "bufferVar.capacity", - "bufferVar.fillmode", - "buffer.write.format()", - "buffer.write.reading()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "25630.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the specified reading buffer.", - "details": "You can call this command to return the number of readings stored in the specified reading buffer.You can use the bufferVar.n attribute in other commands. For example, to print all the readings in a buffer, use the following command:Where bufferVar is the name of the buffer to use.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the reading buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(100);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.n);print(defbuffer1.n);print(defbuffer2.n);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the number of readings in testData.\n--- --Output:\n--- --3\n--- --Print the number of readings in defbuffer1.\n--- --Example output:\n--- --0\n--- --Print the number of readings in defbuffer2.\n--- --Example output:\n--- --0\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "timer.gettime()", - "webhelpfile": "25635.htm", - "signature": "timer.gettime()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function measures the elapsed time since the timer was last cleared.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.cleartime()" - ] - }, - { - "name": "timer.cleartime()", - "webhelpfile": "25636.htm", - "signature": "timer.cleartime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "dataqueue.clear()dataqueue.add(35)timer.cleartime()delay(0.5)dt = timer.gettime()print(\"Delay time was \" .. dt)print(dataqueue.next())", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.cleartime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.gettime()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "25637.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending command triggers.", - "details": "A command trigger indicates if a trigger event has been detected over a command interface since the last trigger.wait() command was sent. Command triggers are generated by:trigger.clear() clears the command triggers and discards the history of trigger events.", - "param_info": [ - { - "name": "*TRGprint(trigger.wait(1))trigger.clear()print(trigger.wait(1))", - "description": "Generate a trigger event.Check if there are any pending trigger events. Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "*TRG;print(trigger.wait(1));trigger.clear();print(trigger.wait(1));", - "description": "Generate a trigger event.\n--- --Check if there are any pending trigger events. \n--- --Output: true\n--- --Clear any pending command triggers.\n--- --Check if there are any pending trigger events.\n--- --Output: false\n" - } - ], - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "25639.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "A trigger was detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "bufferVar.formattedreadings", - "webhelpfile": "25640.htm", - "signature": "bufferVar.formattedreadings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the stored readings shown as numbers with units and prefixes.", - "details": "This read-only attribute is an array that contains the stored readings. The readings are shown as numbers with prefixes before the units symbol.", - "param_info": [ - { - "name": "reading", - "description": "Buffer reading formatted with numbers and prefixes with units for element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.formattedreadings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.formattedreadings[1]);printbuffer(1, testData.n, testData.formattedreadings);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading.\n--- --Example output:\n--- --+00.0028 nA\n--- --Print all readings in the reading buffer.\n--- --Example output:\n--- --+00.0028 nA, +00.0039 nA, +00.0040 nA\n--- --\u00a0\n" - } - ], - "related_commands": [ - "bufferVar.readings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.units", - "webhelpfile": "25641.htm", - "signature": "bufferVar.units[N]", - "command_return": "readingUnit", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "details": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "param_info": [ - { - "name": "readingUnit", - "description": "Volt DC", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingUnit = bufferVar.units[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);testData.fillmode = buffer.FILL_CONTINUOUS;smu.measure.func = smu.FUNC_DC_CURRENT;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the buffer to fill continuously.\n--- --Set the measure function to current.\n--- --Make three readings.\n--- --Print the units for the readings.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the measure function to voltage.\n--- --Make three readings.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.saveappend()", - "webhelpfile": "25642.htm", - "signature": "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function appends data from the reading buffer to a file on the USB flash drive.", - "details": "If the file you specify does not exist on the USB flash drive, this command creates the file.For options that save more than one item of time information, each item is comma-delimited. For example, the default format is date, time, and fractional seconds for each reading.The file extension .csv is appended to the file name if necessary. Any file extension other than .csv generates an error.The index column entry in the .csv file starts at 1 for each append operation.Examples of valid destination file names:Invalid destination file name examples:\u2014 The period is not followed by csv.\u2014 The only allowed extension is .csv. If .csv is not assigned, it is automatically added.", - "param_info": [ - { - "name": "bufferVar", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Indicates how date and time information from the buffer is saved in the file on the USB flash drive; the options are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersaveappendtimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)", - "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)" - ], - "overloads": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)" - ], - "examples": [ - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myData.csv\");", - "description": "Append reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Append readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash\u00a0drive.\n" - }, - { - "example": "reset();if file.usbdriveexists() == 1 then; testDir = \"TestData11\";-- Create a directory on the USB drive for the data.; file.mkdir(testDir);-- Build the full file and path.; fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";-- Open the file where the data will be stored.; fileNumber = file.open(fileName, file.MODE_WRITE);-- Write the string data to a file.; file.write(fileNumber, \"Tested to Company Standard ABC.101\\n\");-- Write the header separator to a file.; file.write(fileNumber, \"====================================================================\\n\");-- Write the string data to a file.; file.write(fileNumber, \"\\t1. Connect HI/LO to respective DUT terminals.\\n\"); file.write(fileNumber, \"\\t2. Set power supply to 5 VDC @ 1 A.\\n\"); file.write(fileNumber, \"\\t3. Wait 30 minutes.\\n\"); file.write(fileNumber, \"\\t4. Capture 100 readings and analyze data.\\n\\n\\n\");-- Write buffering data to a file.; file.flush(fileNumber);-- Close the data file.; file.close(fileNumber);end;-- Fix the range to 10 V.;smu.measure.range = 10.0;-- Set the measurement count to 100.;smu.measure.count = 100;-- Set up reading buffers.;-- Ensure the default measurement buffer size matches the count.;defbuffer1.capacity = smu.measure.count;smu.measure.read();buffer.saveappend(defbuffer1, fileName);", - "description": "Write string data to a file with information about a test file.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.save()" - ] - }, - { - "name": "smu.measure.math.enable", - "webhelpfile": "25644.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables math operations on measurements for the selected measurement function.", - "details": "When this command is set to on, the math operation specified by the math format command is performed before completing a measurement.", - "param_info": [ - { - "name": "value", - "description": "The math enable setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasuremathenablevalue", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathenablefunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.enable", - "smu.measure.math.enable = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_ENABLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;", - "description": "When voltage measurements are made, the math format is enabled and set to percent.\n" - } - ], - "related_commands": [ - "smu.measure.math.format" - ] - }, - { - "name": "smu.measure.rel.acquire()", - "webhelpfile": "25645.htm", - "signature": "smu.measure.rel.acquire()", - "command_return": "relativeValue", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function acquires a measurement and stores it as the relative offset value.", - "details": "This command triggers the instrument to make a new measurement for the selected function. This measurement is then stored as the new relative offset level.When you send this command, the instrument does not apply any math, limit test, or filter settings to the measurement, even if they are set. It is a measurement that is made as if these settings are disabled.If an error event occurs during the measurement, nil is returned and the relative offset level remains at the last valid setting.You must change to the function for which you want to acquire a value before sending this command.The instrument must have relative offset enabled to use the acquired relative offset value.After executing this command, you can use the smu.measure.rel.level attribute to see the last relative level value that was acquired or that was set.", - "param_info": [ - { - "name": "relativeValue", - "description": "The internal measurement acquired for the relative offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "relativeValue = smu.measure.rel.acquire()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.enable", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.limit[Y].autoclear", - "webhelpfile": "25682.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the test result for limit Y should be cleared automatically or not.", - "details": "When auto clear is set to on, limit conditions are cleared automatically after each measurement. If you are making a series of measurements, the instrument shows the limit test result of the last measurement for the pass or fail indication for the limit.If you want to know if any of a series of measurements failed the limit, set the auto clear setting to off. When this is set to off, a failed indication is not cleared automatically. It remains set until it is cleared with the clear command.The auto clear setting affects both the high and low limits.", - "param_info": [ - { - "name": "value", - "description": "The auto clear setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitautoclearvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitautoclearfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].autoclear = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[1].autoclear = smu.ON;", - "description": "Turns on autoclear for limit 1 when measuring DC current.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].clear()" - ] - }, - { - "name": "smu.measure.limit[Y].clear()", - "webhelpfile": "25683.htm", - "signature": "smu.measure.limit[Y].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the results of the limit test defined by Y for the selected measurement function.", - "details": "Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared.To avoid the need to manually clear the test results for a limit, turn the auto clear option on.", - "param_info": [ - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.limit[Y].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[2].clear();", - "description": "Clears the test result for the high and low limit 2 for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear" - ] - }, - { - "name": "smu.measure.limit[Y].fail", - "webhelpfile": "25684.htm", - "signature": "", - "command_return": "result", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute queries the results of a limit test.", - "details": "This command queries the result of a limit test for the selected measurement function.The response message indicates if the limit test passed or how it failed (on the high or low limit).If autoclear is set to off, reading the results of a limit test does not clear the fail indication of the test. To clear a failure, send the clear command. To automatically clear the results, set auto clear on.If auto clear is set to on and you are making a series of measurements, the last measurement limit determines the fail indication for the limit. If auto clear is turned off, the results return a test fail if any of one of the readings failed.To use this attribute, you must set the limit state to on.If the readings are stored in a reading buffer, you can use the bufferVar.statuses command to see the results.This example enables limits 1 and 2 for voltage, measurements. Limit 1 is checking for readings to be between 3 and 5 V, while limit\u00a02 is checking for the readings to be between 1 and 7 V. The auto clear feature is disabled, so if any reading is outside these limits, the corresponding fail is 1. Therefore, if any one of the fails is 1, analyze the reading buffer data to find out which reading failed the limits.", - "param_info": [ - { - "name": "result", - "description": "The results of the limit test for limit Y", - "enum": "smu.FAIL_NONE nil|smu.FAIL_HIGH nil|smu.FAIL_LOW nil|smu.FAIL_BOTH nil", - "type": "smumeasurelimitfailresult", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitfailfunction", - "range": "" - } - ], - "usage": [ - "result = smu.measure.limit[Y].fail", - "result = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_FAIL_Y)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();-- set the instrument source current;smu.source.func = smu.FUNC_DC_CURRENT;-- set the instrument to measure voltage;smu.measure.func = smu.FUNC_DC_VOLTAGE;-- set the range to 10 V;smu.measure.range = 10;-- set the nplc to 0.1;smu.measure.nplc = 0.1;-- disable auto clearing for limit 1;smu.measure.limit[1].autoclear = smu.OFF;-- set high limit on 1 to fail if reading exceeds 5 V;smu.measure.limit[1].high.value = 5;-- set low limit on 1 to fail if reading is less than 3 V;smu.measure.limit[1].low.value = 3;--- set the beeper to sound if the reading exceeds the limits for limit 1;smu.measure.limit[1].audible = smu.AUDIBLE_FAIL;-- enable limit 1 checking for voltage measurements;smu.measure.limit[1].enable = smu.ON;-- disable auto clearing for limit 2;smu.measure.limit[2].autoclear = smu.OFF;-- set high limit on 2 to fail if reading exceeds 7 V;smu.measure.limit[2].high.value = 7;-- set low limit on 2 to fail if reading is less than 1 V;smu.measure.limit[2].low.value = 1;-- enable limit 2 checking for voltage measurements;smu.measure.limit[2].enable = smu.ON;-- set the measure count to 50;smu.measure.count = 50;-- create a reading buffer that can store 100 readings;LimitBuffer = buffer.make(100);-- make 50 readings and store them in LimitBuffer;smu.measure.read(LimitBuffer);-- Check if any of the 50 readings were outside of the limits;print(\"limit 1 results = \" .. smu.measure.limit[1].fail);print(\"limit 2 results = \" .. smu.measure.limit[2].fail);-- clear limit 1 conditions;smu.measure.limit[1].clear();-- clear limit 2 conditions;smu.measure.limit[2].clear();", - "description": "Example output that shows all readings are within limit values (all readings between 3 V and 5 V):\n--- --limit 1 results = smu.FAIL_NONE\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 high values (a 6\u00a0V reading would cause this condition or a reading greater than 5 V but less than 7 V):\n--- --limit 1 results = smu.FAIL_HIGH\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 and 2 low values (a 0.5 V reading would cause this condition or a reading less than 1\u00a0V):\n--- --limit 1 results = smu.FAIL_LOW\n--- --limit 2 results = smu.FAIL_LOW\n" - } - ], - "related_commands": [ - "bufferVar.statuses", - "Limit testing and binning", - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].high.value", - "webhelpfile": "25685.htm", - "signature": "", - "command_return": "highLimit", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the upper limit for a limit test.", - "details": "This command sets the high limit for the limit Y test for the selected measurement function. When limit Y testing is enabled, the instrument generates a fail indication when the measurement value is more than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "highLimit", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)", - "enum": "", - "type": "number", - "range": "(-9.99999e+11 to +9.99999e+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimithighvaluefunction", - "range": "" - } - ], - "usage": [ - "highLimit = smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].high.value = highLimit", - "highLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_HIGH_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_HIGH_Y, highLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "highLimit;", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].low.value", - "webhelpfile": "25686.htm", - "signature": "", - "command_return": "lowLimit", - "type": "Attribute (RW)", - "default_value": "-1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the lower limit for limit tests.", - "details": "This command sets the lower limit for the limit Y test for the selected measure function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "lowLimit", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)", - "enum": "", - "type": "number", - "range": "(-9.99999E+11 to 9.99999E+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitlowvaluefunction", - "range": "" - } - ], - "usage": [ - "lowLimit = smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].low.value = lowLimit", - "lowLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_LOW_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_LOW_Y, lowLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "lowLimit;", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.math.format", - "webhelpfile": "25687.htm", - "signature": "", - "command_return": "operation", - "type": "Attribute (RW)", - "default_value": "smu.MATH_PERCENT\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which math operation is performed on measurements when math operations are enabled.", - "details": "This specifies which math operation is performed on measurements for the selected measurement function.You can choose one of the following math operations:Math calculations are applied to the input signal after relative offset and before limit tests.", - "param_info": [ - { - "name": "operation", - "description": "Math operation to be performed on measurements", - "enum": "smu.MATH_MXB nil|smu.MATH_PERCENT nil|smu.MATH_RECIPROCAL nil", - "type": "smumeasuremathformatoperation", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathformatfunction", - "range": "" - } - ], - "usage": [ - "operation = smu.measure.math.format", - "smu.measure.math.format = operation", - "operation = smu.measure.getattribute(function, ATTR_MEAS_MATH_FORMAT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_FORMAT, operation)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;", - "description": "Enables the reciprocal math operation on voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.mfactor", - "smu.measure.math.percent" - ] - }, - { - "name": "smu.measure.read()", - "webhelpfile": "25688.htm", - "signature": "smu.measure.read(bufferName)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes measurements, places them in a reading buffer, and returns the last reading.", - "details": "This function makes a measurement using the present function setting, stores the reading in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed. You can also use the trigger model Simple Loop.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is defined, it defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading = smu.measure.read()", - "reading = smu.measure.read(bufferName)" - ], - "overloads": [ - "reading = smu.measure.read()" - ], - "examples": [ - { - "example": "voltMeasBuffer = buffer.make(10000);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.read(voltMeasBuffer));", - "description": "Create a buffer named voltMeasBuffer. Set the instrument to measure voltage.\n--- --Make a measurement that is stored in the voltMeasBuffer and is also printed.\n" - } - ], - "related_commands": [ - "buffer.make()", - "smu.measure.count", - "smu.measure.unit", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.measure.configlist.create()", - "webhelpfile": "25691.htm", - "signature": "smu.measure.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty measure configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");", - "description": "Create a measure configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.catalog()", - "smu.measure.configlist.delete()", - "smu.measure.configlist.query()", - "smu.measure.configlist.recall()", - "smu.measure.configlist.size()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.store()", - "webhelpfile": "25693.htm", - "signature": "smu.source.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active source settings into the named configuration list.", - "details": "Use this command to store the active source settings to a configuration index in a configuration list. If the index is defined, the configuration list is stored in that index. If the index is not defined, the configuration index is appended to the end of the list. If a configuration index already exists for the specified index, the new configuration overwrites the existing configuration index.Refer to Settings stored in a source configuration index for information about the settings this command stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.store(listName)", - "smu.source.configlist.store(listName, index)" - ], - "overloads": [ - "smu.source.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.store(\"MyConfigList\");", - "description": "Store the active settings of the instrument to the source configuration list MyConfigList. Settings are saved at the end of the list since no index parameter is specified.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.configlist.catalog()", - "webhelpfile": "25695.htm", - "signature": "smu.source.configlist.catalog()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one source configuration list.", - "details": "You can use this command to retrieve the names of source configuration lists that are stored in the instrument.This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no source configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "print(smu.source.configlist.catalog())", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.catalog());", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.create()", - "webhelpfile": "25696.htm", - "signature": "smu.source.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty source configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. If you want to save a configuration list through a power cycle, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;\u00a0;smu.source.configlist.create(\"MyScrList\");\u00a0;print(smu.source.configlist.catalog());\u00a0;print(smu.source.configlist.catalog());\u00a0;\u00a0;\u00a0;smu.source.configlist.store(\"MyScrList\");smu.source.configlist.store(\"MyScrList\");print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Create a source configuration list named MyScrLst.\n--- --Print the name of one configuration list stored in volatile memory.\n--- --Output:\n--- --MyScrList\n--- --Print the name of one configuration list.\n--- --Output:\n--- --nil\n--- --Nil indicates that no more configuration lists are stored.\n--- --Store a configuration index in MyScrList.\n--- --Store a configuration index in MyScrList.\n--- --Print the number of configuration indexes in MyScrList.\n--- --Output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.delete()", - "webhelpfile": "25697.htm", - "signature": "smu.source.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a source configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.delete(listName)", - "smu.source.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.source.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.delete(\"mySourceList\");", - "description": "Deletes a configuration list named mySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.query()", - "webhelpfile": "25698.htm", - "signature": "smu.source.configlist.query(listName, index, fieldSeparator)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command can only return data for one configuration index. To get data for additional configuration indexes, resend the command and specify different configuration indexes. Refer to Settings stored in a source configuration list for a complete list of source settings that the instrument stores in a source configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list; the default is the first index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.query(listName, index)", - "smu.source.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "smu.source.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(smu.source.configlist.query(\"MyScrList\", 2));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.size()", - "webhelpfile": "25700.htm", - "signature": "smu.source.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of configuration indexes in a source configuration list.", - "details": "The size of the list is equal to the number of configuration indexes in a configuration list.", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total quantity of indexes stored in the specified source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.source.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Determine the number of configuration indexes in a source configuration list named MyScrList.\n--- --Example output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "eventlog.save()", - "webhelpfile": "25702.htm", - "signature": "eventlog.save(filename, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the event log to a file on a USB flash drive.", - "details": "This command saves all event log entries to a USB flash drive.If you do not define an event type, the instrument saves all event log entries.The extension .csv is automatically added to the file name.", - "param_info": [ - { - "name": "filename", - "description": "A string that represents the name of the file to be saved", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsaveeventType", - "range": "" - } - ], - "usage": [ - "eventlog.save(filename)", - "eventlog.save(filename, eventType)" - ], - "overloads": [ - "eventlog.save(filename)" - ], - "examples": [ - { - "example": "eventlog.save(\"/usb1/WarningsApril\", eventlog.SEV_WARN);", - "description": "Save warning messages to a .csv file on a USB flash drive.\n" - } - ], - "related_commands": [ - "eventlog.next()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "25706.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This command allows you to change or view how many readings a buffer can store. Changing the size of a buffer will cause any existing data in the buffer to be lost.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store; set to 0 to maximize the buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity", - "bufferVar.capacity = bufferCapacity" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(500);capTest = buffer.make(300);bufferCapacity = capTest.capacity;\u00a0;print(bufferCapacity);\u00a0;\u00a0;print(testData.capacity);\u00a0;\u00a0;testData.capacity = 600;print(testData.capacity);print(defbuffer1.capacity);", - "description": "Create two user-defined reading buffers: testData and capTest.\n--- --\u00a0\n--- --Create a variable called bufferCapacity to hold the capacity of the capTest buffer.\n--- --Print bufferCapacity.\n--- --Output:\n--- --300\n--- --Print the capacity of testData.\n--- --Output:\n--- --500\n--- --Changes the capacity of testData to 600.\n--- --Print the capacity of testData.\n--- --Output:\n--- --600\n--- --Print the capacity of the default buffer defbuffer1.\n--- --Output:\n--- --10000\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourceunits", - "webhelpfile": "25707.htm", - "signature": "bufferVar.sourceunits[N]", - "command_return": "readingUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of measure of the source.", - "details": "The attribute is an array (a Lua table) of strings indicating the units of measure at the time of the reading.", - "param_info": [ - { - "name": "readingUnits", - "description": "The units of measure of the source", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "readingUnits = bufferVar.sourceunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;testData.fillmode = buffer.FILL_CONTINUOUS;trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_CURRENT;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);smu.source.output = smu.OFF;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source output to ON.\n--- --Set the buffer to fill continuously.\n--- --Set the source function to current.\n--- --Take three readings.\n--- --Print the units for the first three readings in the buffer.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the source function to voltage.\n--- --Take three readings.\n--- --Print the units for the readings in the buffer.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "bufferVar.sourceunits", - "bufferVar.sourcevalues", - "bufferVar.statuses" - ] - }, - { - "name": "bufferVar.relativetimestamps", - "webhelpfile": "25712.htm", - "signature": "bufferVar.relativetimestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamps, in seconds, when each reading occurred, relative to the timestamp of the first entry in the reading buffer.", - "details": "This read-only attribute is an array of timestamps, in seconds, of when each reading occurred relative to the timestamp of the first entry in the reading buffer. These timestamps are equal to the time that has lapsed for each reading since the first reading was stored in the buffer. Therefore, the relative timestamp for the first entry number in the reading buffer equals 0.", - "param_info": [ - { - "name": "timestamp", - "description": "The timestamp, in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timestamp = bufferVar.relativetimestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.relativetimestamps[1]);printbuffer(1, 3, testData.relativetimestamps);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --\u00a0\n--- --Print the relative timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0\n--- --Print the relative timestamp for the reading 1 through 3 in the buffer.\n--- --Example output:\n--- --0, 0.383541, 0.772005\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.seconds", - "webhelpfile": "25713.htm", - "signature": "bufferVar.seconds[N]", - "command_return": "nonFracSeconds", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp of a reading in seconds, in UTC format.", - "details": "This attribute contains the nonfractional seconds portion of the timestamp when the reading was stored in Coordinated Universal Time (UTC) format.The nonfractional seconds portion of the timestamp gives the lowest resolution down to 1 second. To access additional resolution of a timestamp, see bufferVar.fractionalseconds.", - "param_info": [ - { - "name": "nonFracSeconds", - "description": "The nonfractional seconds portion of the timestamp when the reading was stored", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "nonFracSeconds = bufferVar.seconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 6, testData.seconds);", - "description": "Create a reading buffer named testData, configure the instrument to make six measurements, and store the readings in the buffer.\n--- --Print the seconds portion for readings 1 to 6 in testData. \n--- --Example output:\n--- --1362261492, 1362261492, 1362261493, 1362261493, 1362261493, 1362261494\n" - } - ], - "related_commands": [ - "bufferVar.fractionalseconds", - "bufferVar.relativetimestamps" - ] - }, - { - "name": "bufferVar.times", - "webhelpfile": "25715.htm", - "signature": "bufferVar.times[N]", - "command_return": "readingTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the time when the instrument made the reading.", - "details": "", - "param_info": [ - { - "name": "readingTime", - "description": "The time of the reading in hours, minutes, and seconds", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTime = bufferVar.times[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.times[1]);printbuffer(1, 3, testData.times);", - "description": "This example creates a reading buffer named testData and makes three measurements.\n--- --The print() command outputs the time of the first reading. \n--- --Output:\n--- --23:09:43\n--- --The printbuffer() command outputs the time of readings 1 to 3 in the reading buffer. \n--- --Output:\n--- --23:09:43, 23:09:43, 23:09:43\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "25716.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "readingTimestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "This attribute contains the timestamps (date, hours, minutes, seconds, and fractional seconds) of readings stored in the reading buffer.", - "param_info": [ - { - "name": "readingTimestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "string[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTimestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.timestamps[1]);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Output:\n--- --03/01/2018 14:46:07.714614838\n" - }, - { - "example": "for x = 1, 3 do printbuffer(x, x, testData.timestamps) end;", - "description": "For the buffer created in Example 1, print the timestamps for the readings.\n--- --Output:\n--- --03/01/2018 14:46:07.71461483803/01/2018 14:46:08.10046883803/01/2018 14:46:08.487631838\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.readingformat", - "webhelpfile": "25719.htm", - "signature": "", - "command_return": "format", - "type": "Attribute (RW)", - "default_value": "display.FORMAT_PREFIX\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the format that is used to display measurement readings on the front-panel display of the instrument.", - "details": "This setting persists through reset() and power cycles.When Prefix is selected, prefixes are added to the units symbol, such as k (kilo) or m (milli). When Exponent is selected, exponents are used instead of prefixes. When the prefix option is selected, very large or very small numbers may be displayed with exponents.", - "param_info": [ - { - "name": "format", - "description": "Use exponent format", - "enum": "display.FORMAT_EXPONENT nil|display.FORMAT_PREFIX nil", - "type": "displayreadingformatformat", - "range": "" - } - ], - "usage": [ - "format = display.readingformat", - "display.readingformat = format" - ], - "overloads": [], - "examples": [ - { - "example": "display.readingformat = display.FORMAT_EXPONENT;", - "description": "Change front-panel display to show readings in exponential format.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "25722.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function defines the text that is displayed on the front-panel USER swipe screen.", - "details": "This command defines text messages for the USER swipe screen.If you enter too many characters, the instrument displays a warning event and shortens the message to fit.When the instrument is reset, the user test is removed and the USER swipe screen is hidden until another message is defined.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "displayArea", - "description": "display.TEXT1 display.TEXT2", - "enum": "display.TEXT1 nil|display.TEXT2 nil", - "type": "displaysettextdisplayArea", - "range": "" - }, - { - "name": "text", - "description": "String that contains the message for the top line of the USER swipe screen (up to 20 characters)", - "enum": "", - "type": "string", - "range": "(up to 20 characters)" - } - ], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"A122 \\185 A123\");display.settext(display.TEXT2, \"Results in \\018\");", - "description": "Clear the USER swipe screen.\n--- --Display the USER swipe screen.\n--- --Set the first line to read \"A122 \u0394 A123\" and the second line to display \"\"Results in \u03a9\":\n--- --\n" - } - ], - "related_commands": [ - "display.clear()", - "display.changescreen()" - ] - }, - { - "name": "file.mkdir()", - "webhelpfile": "25723.htm", - "signature": "file.mkdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a directory at the specified path on the USB flash drive.", - "details": "The directory path must be absolute. The name of the directory must not already exist on the flash drive.", - "param_info": [ - { - "name": "path", - "description": "A string that contains the path of the directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.mkdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "file.mkdir(\"TestData\");", - "description": "Create a new directory named TestData.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.open()", - "webhelpfile": "25724.htm", - "signature": "file.open(fileName, accessType)", - "command_return": "fileNumber", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file on the USB flash drive for later reference.", - "details": "The path to the file to open must be absolute.The root folder of the USB flash drive has the following absolute path:", - "param_info": [ - { - "name": "fileNumber", - "description": "A number identifying the open file that you use with other file commands to write, read, flush, or close the file after opening", - "enum": "", - "type": "file_object", - "range": "" - }, - { - "name": "fileName", - "description": "A string that contains the file name to open, including the full path of file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "accessType", - "description": "The type of action to do", - "enum": "file.MODE_APPEND nil|file.MODE_READ nil|file.MODE_WRITE nil", - "type": "fileopenaccessType", - "range": "" - } - ], - "usage": [ - "fileNumber = file.open(fileName, accessType)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.ipconfig()", - "webhelpfile": "25725.htm", - "signature": "lan.ipconfig()", - "command_return": "method, ipV4Address, subnetMask, gateway", - "type": "Function", - "default_value": "lan.MODE_AUTO\n", - "tsp_link": "No\n", - "description": "This function specifies the LAN configuration for the instrument.", - "details": "This command specifies how the LAN IP address and other LAN settings are assigned. If automatic configuration is selected, the instrument automatically determines the LAN information. When method is automatic, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, an error occurs.If manual is selected, you must define the IP address. You can also assign a subnet mask, and default gateway. The IP address, subnet mask, and default gateway must be formatted in four groups of numbers, each separated by a decimal. If you do not specify a subnet mask or default gateway, the previous settings are used.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.MODE_AUTO nil|lan.MODE_MANUAL nil", - "type": "lanipconfigmethod", - "range": "" - }, - { - "name": "ipV4Address", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "subnetMask", - "description": "The LAN subnet mask; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "gateway", - "description": "The LAN default gateway; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "method, ipV4Address, subnetMask, gateway = lan.ipconfig()", - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "overloads": [ - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "examples": [ - { - "example": "lan.ipconfig(lan.MODE_AUTO);print(lan.ipconfig());lan.ipconfig(lan.MODE_MANUAL, \"192.168.0.7\", \"255.255.240.0\", \"192.168.0.3\");print(lan.ipconfig());", - "description": "Set the IP configuration method to automatic. Request the IP configuration. Example output:\n--- --lan.MODE_AUTO 134.63.78.136\u00a0\u00a0 255.255.254.0\u00a0\u00a0 134.63.78.1\n--- --Set the IP configuration method to manual. Request the IP configuration. Output:\n--- --lan.MODE_MANUAL 192.168.0.7\u00a0\u00a0\u00a0 255.255.240.0\u00a0 192.168.0.3\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.settime()", - "webhelpfile": "25726.htm", - "signature": "localnode.settime(year, month, day, hour, minute, second)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the date and time of the instrument.", - "details": "Internally, the instrument bases time in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).When called without a parameter (the first form), the function returns the current time.", - "param_info": [ - { - "name": "year", - "description": "Year; must be more than 1970", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "month", - "description": "Month (1 to 12)", - "enum": "", - "type": "number", - "range": "(1 to 12)" - }, - { - "name": "day", - "description": "Day (1 to 31)", - "enum": "", - "type": "number", - "range": "(1 to 31)" - }, - { - "name": "hour", - "description": "Hour in 24-hour time format (0 to 23)", - "enum": "", - "type": "number", - "range": "(0 to 23)" - }, - { - "name": "minute", - "description": "Minute (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - }, - { - "name": "second", - "description": "Second (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - } - ], - "usage": [ - "localnode.settime()", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "overloads": [ - "localnode.settime()", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "examples": [ - { - "example": "localnode.settime(2017, 12, 5, 15, 48, 20);print(localnode.settime());", - "description": "Sets the date and time to December 5, 2017 at 3:48:20\u00a0pm and verifies the time.\n--- --Output:\n--- --Tue Dec 5 15:48:20 2017\n" - }, - { - "example": "systemTime = os.time({year = 2018,; month = 3,; day = 31,; hour = 14,; min = 25});localnode.settime(systemTime);print(os.date('%c', gettime()));", - "description": "Sets the date and time to Mar 31, 2018 at 2:25\u00a0pm.\n--- --Output:\n--- --Sat Mar 31 14:25:00 2018\n" - } - ], - "related_commands": [ - "localnode.gettime()" - ] - }, - { - "name": "smu.interlock.tripped", - "webhelpfile": "25729.htm", - "signature": "", - "command_return": "interlockStatus", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates that the interlock has been tripped.", - "details": "This command gives you the status of the interlock. When the safety interlock signal is asserted, all voltage ranges of the instrument are available. However, when the safety interlock signal is not asserted, the 200\u00a0V range is hardware limited to a nominal output of less than \u00b142\u00a0V.When the interlock is not asserted:", - "param_info": [ - { - "name": "interlockStatus", - "description": "The status of the interlock", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlocktrippedinterlockStatus", - "range": "" - } - ], - "usage": [ - "interlockStatus = smu.interlock.tripped" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.interlock.tripped);", - "description": "If the interlock is not asserted, returns smu.OFF.\n--- --If the interlock is asserted, returns smu.ON.\n" - } - ], - "related_commands": [ - "smu.interlock.enable" - ] - }, - { - "name": "smu.measure.sense", - "webhelpfile": "25730.htm", - "signature": "", - "command_return": "sensing", - "type": "Attribute (RW)", - "default_value": "smu.SENSE_2WIRE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects local (2-wire) or remote (4-wire) sensing.", - "details": "This command determines if 2-wire (local) or 4-wire (remote) sensing is used.When you use 4-wire sensing, voltages are measured at the device under test (DUT). For the source voltage, if the sensed voltage is lower than the programmed amplitude, the voltage source increases the voltage until the sensed voltage is the same as the programmed amplitude. This compensates for IR drop in the output test leads.Using 4-wire sensing with voltage measurements eliminates any voltage drops that may be in the test leads between the Model 2450 and the DUT.When you are using 2-wire sensing, voltage is measured at the output connectors.When you are measuring resistance, you can enable 4-wire sensing to make 4-wire resistance measurements.When the output is off, 4-wire sensing is disabled and the instrument uses 2-wire sense, regardless of the sense setting. When the output is on, the selected sense setting is used.If the output is on when you change the sense setting, the output is turned off. ", - "param_info": [ - { - "name": "sensing", - "description": "Two-wire sensing", - "enum": "smu.SENSE_2WIRE nil|smu.SENSE_4WIRE nil", - "type": "smumeasuresensesensing", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuresensefunction", - "range": "" - } - ], - "usage": [ - "sensing = smu.measure.sense", - "smu.measure.sense = sensing", - "sensing = smu.measure.getattribute(function, ATTR_MEAS_SENSE)", - "smu.measure.setattribute(function, ATTR_MEAS_SENSE, sensing)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;", - "description": "Set the measurement function to resistance.\n--- --Set the sense to 4-wire remote.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.terminals", - "webhelpfile": "25737.htm", - "signature": "", - "command_return": "terminals", - "type": "Attribute (RW)", - "default_value": "smu.TERMINALS_FRONT\n", - "tsp_link": "Yes\n", - "description": "This attribute describes which set of input and output terminals the instrument is using.", - "details": "This command selects which set of input and output terminals the instrument uses. You can select front panel or rear panel terminals.If the output is on when you change from one set of terminals to the other, the output is turned off.This command replaces the smu.measure.terminals command, which is deprecated.", - "param_info": [ - { - "name": "terminals", - "description": "Use the front-panel input and output terminals", - "enum": "smu.TERMINALS_FRONT nil|smu.TERMINALS_REAR nil", - "type": "smuterminalsterminals", - "range": "" - } - ], - "usage": [ - "terminals = smu.terminals", - "smu.terminals = terminals" - ], - "overloads": [], - "examples": [ - { - "example": "smu.terminals = smu.TERMINALS_FRONT;", - "description": "Use the front-panel terminals for measurements.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.state()", - "webhelpfile": "25741.htm", - "signature": "trigger.model.state()", - "command_return": "status, status, n", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the present state of the trigger model.", - "details": "This command returns the state of the trigger model. The instrument checks the state of a started trigger model every 100\u00a0ms.This command returns the trigger state and the block that the trigger model last executed.The trigger model states are:", - "param_info": [ - { - "name": "status", - "description": "The status of the trigger model", - "enum": "trigger.STATE_ABORTED nil|trigger.STATE_ABORTING nil|trigger.STATE_BUILDING nil|trigger.STATE_EMPTY nil|trigger.STATE_FAILED nil|trigger.STATE_IDLE nil|trigger.STATE_RUNNING nil|trigger.STATE_WAITING nil", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "status", - "description": "The status of the parallel/dual trigger model", - "enum": "", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "n", - "description": "The last trigger model block that was executed", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status, status, n = trigger.model.state()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.state());", - "description": "An example output if the trigger model is waiting and is at block 9 would be:\n--- --trigger.STATE_WAITING trigger.STATE_EMPTY 9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "27637.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all events from the event log, including entries in the front-panel event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "eventlog.next()", - "eventlog.save()" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "27658.htm", - "signature": "eventlog.next(eventType)", - "command_return": "eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log.", - "details": "When an event occurs on the instrument, it is placed in the event log. The eventlog.next() command retrieves an unread event from the event log. Once an event is read, it can no longer be accessed remotely. However, it can be viewed on the front panel. When localnode.showevents is enabled, this command never returns an event because those events are automatically read and sent to the remote interface.To read multiple events, execute this command multiple times.If there are no entries in the event log, the following is returned:If the event type is not defined, an event of any type is returned.", - "param_info": [ - { - "name": "eventNumber", - "description": "The event number", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "message", - "description": "A description of the event", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity of the event", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "nodeID", - "description": "The TSP-Link node where the event occurred or 0 if the event occurred on the local node", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeSeconds", - "description": "The seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeNanoSeconds", - "description": "The fractional seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlognexteventType", - "range": "" - } - ], - "usage": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()", - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next(eventType)" - ], - "overloads": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()" - ], - "examples": [ - { - "example": "print(eventlog.next(5));", - "description": "Get the oldest error or information event from the event log.\n--- --Example output:\n--- ---285 TSP Syntax error at line 1: unexpected symbol near `0' 1 0 1367806152 652040060\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.getcount()", - "eventlog.save()" - ] - }, - { - "name": "file.read()", - "webhelpfile": "27929.htm", - "signature": "file.read(fileNumber, readAction)", - "command_return": "fileContents", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file on the USB flash drive.", - "details": "This command reads data from a file.", - "param_info": [ - { - "name": "fileContents", - "description": "The contents of the file based on the readAction parameter", - "enum": "", - "type": "string | nil", - "range": "" - }, - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to read", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "readAction", - "description": "The action", - "enum": "file.READ_LINE nil|file.READ_NUMBER nil|file.READ_ALL nil", - "type": "filereadreadAction", - "range": "" - } - ], - "usage": [ - "fileContents = file.read(fileNumber, readAction)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_READ);if file_num != nil then; file_contents = file.read(file_num, file.READ_ALL); file.close(file_num);end;", - "description": "Open testfile.txt on the USB flash drive for reading. If it opens successfully, read the entire contents of the file and store it in variable file_contents.\n--- --Close the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.close()", - "webhelpfile": "27930.htm", - "signature": "file.close(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes a file on the USB flash drive.", - "details": "Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to close", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.close(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/GENTRIGGER\", file.MODE_WRITE);file.close(file_num);", - "description": "Open the file GENTRIGGER for writing, then close it.\n" - } - ], - "related_commands": [ - "file.open()" - ] - }, - { - "name": "file.write()", - "webhelpfile": "27934.htm", - "signature": "file.write(fileNumber, string)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file on the USB flash drive.", - "details": "The file.write() function may include data that is buffering; it may not be written to the USB flash drive immediately. Use the file.flush() function to immediately write buffered data to the drive.You must use the file.close() command to close the file after writing.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to write", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "string", - "description": "A string that contains the data to write to the file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.write(fileNumber, string)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "file.close()", - "file.flush() " - ] - }, - { - "name": "file.flush()", - "webhelpfile": "27958.htm", - "signature": "file.flush(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffering data to a file on the USB flash drive.", - "details": "The file.write() function may be buffering data instead of writing immediately to the USB flash drive. Use file.flush() to flush this data. Data may be lost if the file is not closed or flushed before a script ends.If there is going to be a time delay before more data is written to a file, flush the file to prevent loss of data because of an aborted test.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to flush", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.flush(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();\u00a0;-- Fix the range to 10 V;smu.measure.range = 10;\u00a0;-- Set the measurement count to 100;smu.measure.count = 100;\u00a0;-- Set up reading buffers;-- Ensure the default measurement buffer size matches the count;defbuffer1.capacity = 100;smu.measure.read();\u00a0;testDir = \"TestData5\";\u00a0;-- create a directory on the USB drive for the data;file.mkdir(testDir);fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";buffer.save(defbuffer1, fileName);\u00a0;if file.usbdriveexists() != 0 then; -- testDir = \"TestData3\";\u00a0; -- Create a directory on the USB drive for the data; -- file.mkdir(testDir); -- Open the file where the data will be stored; -- fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\"; fileNumber = file.open(fileName, file.MODE_APPEND);-- Write header separator to file; file.write(fileNumber, \"\\n\\n====================================================================\\n\");-- Write the string data to a file; file.write(fileNumber, \"Tested to Company Standard ABC.123\\n\");-- Ensure a hurry-up of data written to the file before close or script end; file.flush(fileNumber);-- Close the data file; file.close(fileNumber);\u00a0;end;", - "description": "This example writes a string that indicates that the readings were made for a certain reason, such as to test to a company standard.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.output", - "webhelpfile": "28022.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "When the output is switched on, the instrument sources either voltage or current, as set by smu.source.func.", - "param_info": [ - { - "name": "sourceOutput", - "description": "Switch the source output off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceoutputsourceOutput", - "range": "" - } - ], - "usage": [ - "sourceOutput = smu.source.output", - "smu.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.output = smu.ON;", - "description": "Switch the source output of the instrument to on.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.offmode" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "28048.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "format.LITTLEENDIAN\n", - "tsp_link": "No\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.REAL32 and format.REAL64 data formats.If you are sending data to a computer with a Microsoft Windows operating system, select the format.LITTLEENDIAN byte order.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.BIGENDIAN nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "Output depends on the terminal program you use, but will look something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "28056.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "0 (Automatic)\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number from 1 to 16; set to 0 to have the instrument select the precision automatically based on the number that is being formatted", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "28063.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "format.ASCII\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "You can control the precision of numeric values with the format.asciiprecision attribute. If format.REAL32 or format.REAL64 is selected, you can select the byte order with the format.byteorder attribute.The IEEE Std 754 binary formats use four bytes for single-precision values and eight bytes for double-precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCII nil|format.REAL32 nil|format.REAL64 nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "trigger.lanin[N].edge", - "webhelpfile": "28111.htm", - "signature": "", - "command_return": "edgeMode", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_EITHER\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.", - "param_info": [ - { - "name": "edgeMode", - "description": "The trigger mode; see the Details for more information", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "edgeMode = trigger.lanin[N].edge", - "trigger.lanin[N].edge = edgeMode" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[1].edge = trigger.EDGE_FALLING;", - "description": "Set the edge state of LAN event 1 to falling.\n" - } - ], - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "smu.measure.displaydigits", - "webhelpfile": "28416.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "smu.DIGITS_5_5\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the number of digits that are displayed for measurements on the front panel for the selected function.", - "details": "This command affects how the reading for a measurement is displayed on the front panel of the instrument. It does not affect the number of digits returned in a remote command reading. It also does not affect the accuracy or speed of measurements.The display digits setting is saved with the function setting, so if you use another function, then return to the function for which you set display digits, the display digits setting you set previously is retained.The change in digits occurs the next time a measurement is made.To change the number of digits returned in a remote command reading, use format.asciiprecision.", - "param_info": [ - { - "name": "digits", - "description": "6\u00bd display digits", - "enum": "smu.DIGITS_6_5 nil|smu.DIGITS_5_5 nil|smu.DIGITS_4_5 nil|smu.DIGITS_3_5 nil", - "type": "smumeasuredisplaydigitsdigits", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuredisplaydigitsfunction", - "range": "" - } - ], - "usage": [ - "digits = smu.measure.displaydigits", - "smu.measure.displaydigits = digits", - "digits = smu.measure.getattribute(function, ATTR_MEAS_DIGITS)", - "smu.measure.setattribute(function, ATTR_MEAS_DIGITS, digits)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.displaydigits = smu.DIGITS_6_5;", - "description": "Set the measurement function to voltage with a front-panel display resolution of 6\u00bd.\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "smu.measure.configlist.catalog()", - "webhelpfile": "28417.htm", - "signature": "smu.measure.configlist.catalog()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one measure configuration list that is stored on the instrument.", - "details": "You can use this command to retrieve the names of measure configuration lists that are stored in the instrument. This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no measure configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "output", - "description": "Returns the name of one measure configuration list that is stored on the instrument", - "enum": "", - "type": "string | nil", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.catalog());", - "description": "Request the name of one measure configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.query()", - "webhelpfile": "28418.htm", - "signature": "smu.measure.configlist.query(listName, index, fieldSeparator)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command recalls data for one configuration index.For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "output", - "description": "Returns a list of TSP commands and parameter settings that are stored in the specified configuration index", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.query(listName, index)", - "output = smu.measure.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "output = smu.measure.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(smu.measure.configlist.query(\"testMeasList\", 2, \"\\n\"));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n--- --Example output:\n--- --smu.measure.func = smu.FUNC_DC_CURRENT\n--- --smu.measure.range = 1.000000e-08\n--- --smu.measure.autorange = smu.ON\n--- --smu.measure.autorangelow = 1.000000e-08\n--- --smu.measure.autozero.enable = smu.ON\n--- --smu.measure.displaydigits = smu.DIGITS_5_5\n--- --smu.measure.filter.enable = smu.OFF\n--- --smu.measure.filter.count = 10\n--- --smu.measure.filter.type = smu.FILTER_REPEAT_AVG\n--- --smu.measure.limit[1].autoclear = smu.ON\n--- --smu.measure.limit[1].enable = smu.OFF\n--- --smu.measure.limit[1].high.value = 1.000000e+00\n--- --smu.measure.limit[1].low.value = -1.000000e+00\n--- --smu.measure.limit[2].autoclear = smu.ON\n--- --smu.measure.limit[2].enable = smu.OFF\n--- --smu.measure.limit[2].high.value = 1.000000e+00\n--- --smu.measure.limit[2].low.value = -1.000000e+00\n--- --smu.measure.math.enable = smu.OFF\n--- --smu.measure.math.format = smu.MATH_PERCENT\n--- --smu.measure.math.mxb.bfactor = 0.000000e+00\n--- --smu.measure.math.mxb.mfactor = 1.000000e+00\n--- --smu.measure.math.percent = 1.000000e+00\n--- --smu.measure.userdelay[1] = 0.000000e+00\n--- --smu.measure.userdelay[2] = 0.000000e+00\n--- --smu.measure.userdelay[3] = 0.000000e+00\n--- --smu.measure.userdelay[4] = 0.000000e+00\n--- --smu.measure.userdelay[5] = 0.000000e+00\n--- --smu.measure.nplc = 1.000000e+00\n--- --smu.measure.offsetcompensation = smu.OFF\n--- --smu.measure.sense = smu.SENSE_2WIRE\n--- --smu.terminals = smu.TERMINALS_FRONT\n--- --smu.measure.unit = smu.UNIT_AMP\n--- --smu.measure.rel.enable = smu.OFF\n--- --smu.measure.rel.level = 0.000000e+00\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.recall()", - "webhelpfile": "28419.htm", - "signature": "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a configuration index in a measure configuration list and an optional source configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a measure configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified measure configuration list. You can optionally specify a source configuration list and index to recall with the measure settings. If you do not specify a source index, the source index defaults to match the measure index. Specify a measure and source list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need the source and measure configuration lists coordinated, you can specify just the measure configuration list with this command and use the smu.source.configlist.recall() command to recall source settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, an error message is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. A single index stores the settings associated with a single measure function.This command recalls data for one configuration index from the specified measure configuration list and from the source configuration list (if specified).For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sourceListName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceIndex", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)", - "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)" - ], - "overloads": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.recall(\"MyMeasList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.measure.configlist.delete()", - "webhelpfile": "28421.htm", - "signature": "smu.measure.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a measure configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.delete(listName)", - "smu.measure.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.delete(\"myMeasList\");", - "description": "Delete a measure configuration list named myMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "lan.macaddress", - "webhelpfile": "28423.htm", - "signature": "", - "command_return": "MACaddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute describes the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets.", - "param_info": [ - { - "name": "MACaddress", - "description": "The MAC address of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "MACaddress = lan.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.macaddress);", - "description": "Returns the MAC address. For example:\n--- --08:00:11:00:00:57\n" - } - ], - "related_commands": [ - "lan.ipconfig()" - ] - }, - { - "name": "smu.measure.autozero.enable", - "webhelpfile": "29048.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "To ensure the accuracy of readings, the instrument must periodically get new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture that is being used for measurements. The Model 2450 uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made.The time to make the reference measurements is in addition to the normal measurement time. If timing is critical, such as in sweeps, you can disable autozero to avoid this time penalty.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "state", - "description": "The status of autozero; set to one of the following values", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautozeroenablestate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautozeroenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autozero.enable", - "smu.measure.autozero.enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_AUTO_ZERO)", - "smu.measure.setattribute(function, ATTR_MEAS_AUTO_ZERO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autozero.enable = smu.OFF;", - "description": "Set autozero off for voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.once()", - "smu.measure.nplc" - ] - }, - { - "name": "smu.measure.autozero.once()", - "webhelpfile": "29049.htm", - "signature": "smu.measure.autozero.once()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to refresh the reference and zero measurements once.", - "details": "This command forces a refresh of the reference and zero measurements that are used for the present aperture setting for the selected function.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "smu.measure.autozero.once()", - "description": "Do a one-time refresh of the reference and zero measurements.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.autozero.once()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.autozero.once();", - "description": "Do a one-time refresh of the reference and zero measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.enable" - ] - }, - { - "name": "smu.measure.nplc", - "webhelpfile": "29064.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the time that the input signal is measured for the selected function.", - "details": "This command sets the amount of time that the input signal is measured.The amount of time is specified as the number of power line cycles (NPLCs). Each PLC for 60\u00a0Hz is 16.67\u00a0ms (1/60) and each PLC for 50\u00a0Hz is 20\u00a0ms (1/50). For 60\u00a0Hz, if you set the NPLC to 0.1, the measure time is 1.667 ms.This command is set for the measurement of specific functions (current, resistance, or voltage).The shortest amount of time results in the fastest reading rate but increases the reading noise and decreases the number of usable digits.The longest amount of time provides the lowest reading noise and more usable digits but has the slowest reading rate.Settings between the fastest and slowest number of power line cycles are a compromise between speed and noise.If you change the PLCs, you may want to adjust the displayed digits to reflect the change in usable digits.", - "param_info": [ - { - "name": "nplc", - "description": "The number of power line cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurenplcfunction", - "range": "" - } - ], - "usage": [ - "nplc = smu.measure.nplc", - "smu.measure.nplc = nplc", - "nplc = smu.measure.getattribute(function, ATTR_MEAS_NPLC)", - "smu.measure.setattribute(function, ATTR_MEAS_NPLC, nplc)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.nplc = 0.5;", - "description": "Set the measurement function to DC Voltage.\n--- --Set the NPLC value to 0.5, which is 0.0083\u00a0seconds (0.5/60).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.protect.level", - "webhelpfile": "29072.htm", - "signature": "", - "command_return": "PROTECT_x", - "type": "Attribute (RW)", - "default_value": "smu.PROTECT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the overvoltage protection setting of the source output.", - "details": "Overvoltage protection restricts the maximum voltage level that the instrument can source. It is in effect when either current or voltage is sourced.This protection is in effect for both positive and negative output voltages.When this attribute is used in a test sequence, it should be set before turning the source on.", - "param_info": [ - { - "name": "PROTECT_x", - "description": "The overvoltage protection level", - "enum": "smu.PROTECT_2V nil|smu.PROTECT_5V nil|smu.PROTECT_10V nil|smu.PROTECT_20V nil|smu.PROTECT_40V nil|smu.PROTECT_60V nil|smu.PROTECT_80V nil|smu.PROTECT_100V nil|smu.PROTECT_120V nil|smu.PROTECT_140V nil|smu.PROTECT_160V nil|smu.PROTECT_180V nil|smu.PROTECT_NONE nil", - "type": "smusourceprotectlevelPROTECT_x", - "range": "" - }, - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceprotectlevelsourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotectlevelfunction", - "range": "" - } - ], - "usage": [ - "PROTECT_x = smu.source.protect.level", - "smu.source.protect.level = PROTECT_x", - "PROTECT_x = smu.source.getattribute(function, ATTR_SRC_PROTECT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_PROTECT_LEVEL, PROTECT_x)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.protect.level = smu.PROTECT_40V;", - "description": "Sets the maximum voltage limit of the instrument to 40\u00a0V.\n" - } - ], - "related_commands": [ - "Overvoltage protection" - ] - }, - { - "name": "smu.source.delay", - "webhelpfile": "29079.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This command sets a delay for the selected source function. This delay is in addition to normal settling times.After the programmed source is turned on, this delay allows the source level to settle before a measurement is made.If you set a specific source delay (smu.source.delay), source autodelay is turned off.When source autodelay is turned on, the manual source delay setting is overwritten with the autodelay setting.When either a source delay or autodelay is set, the delay is applied to the first source output and then only when the magnitude of the source changes.", - "param_info": [ - { - "name": "sDelay", - "description": "The length of the delay (0 to 10 ks)", - "enum": "", - "type": "number", - "range": "(0 to 10 ks)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcedelayfunction", - "range": "" - } - ], - "usage": [ - "sDelay = smu.source.delay", - "smu.source.delay = sDelay", - "sDelay = smu.source.getattribute(function, ATTR_SRC_DELAY)", - "smu.source.setattribute(function, ATTR_SRC_DELAY, sDelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.delay = 3;", - "description": "Set the function to voltage. Set a 3 s delay after the source is turned on before a measurement is made.\n" - } - ], - "related_commands": [ - "smu.source.autodelay" - ] - }, - { - "name": "smu.measure.offsetcompensation", - "webhelpfile": "29137.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if offset compensation is used.", - "details": "This feature is only available for resistance measurements or when the smu.measure.unit is set to smu.UNIT_OHM.", - "param_info": [ - { - "name": "state", - "description": "Disable offset compensation", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureoffsetcompensationstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureoffsetcompensationfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.offsetcompensation", - "smu.measure.offsetcompensation = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_OFFSET_COMP)", - "smu.measure.setattribute(function, ATTR_MEAS_OFFSET_COMP, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;smu.measure.offsetcompensation = smu.ON;smu.source.output = smu.ON;print(smu.measure.read());smu.source.output = smu.OFF;", - "description": "Sets the measurement function to resistance. Set the instrument for 4-wire measurements and turn offset compensation on. Turn on the source, make a measurement, and turn the source off.\n--- --Example output:\n--- --81592000\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.offmode", - "webhelpfile": "29238.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "smu.OFFMODE_NORMAL\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the state of the source when the output is turned off.", - "details": "", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceoffmodesourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceoffmodefunction", - "range": "" - } - ], - "usage": [ - "sourceOffMode = smu.source.offmode", - "smu.source.offmode = sourceOffMode", - "sourceOffMode = smu.source.getattribute(function, ATTR_SRC_OFFMODE)", - "smu.source.setattribute(function, ATTR_SRC_OFFMODE, sourceOffMode)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.offmode = smu.OFFMODE_HIGHZ;", - "description": "Sets the output-off state so that the instrument opens the output relay when the output is turned off.\n" - } - ], - "related_commands": [ - "smu.source.output" - ] - }, - { - "name": "smu.source.func", - "webhelpfile": "29382.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_VOLTAGE\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "When you set this command, it configures the instrument as either a voltage source or a current source.When you read this command, it returns the output setting of the source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcefuncsFunction", - "range": "" - } - ], - "usage": [ - "sFunction = smu.source.func", - "smu.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;", - "description": "Sets the source function of the instrument to be a current source.\n" - } - ], - "related_commands": [ - "smu.source.level", - "smu.source.output" - ] - }, - { - "name": "smu.source.range", - "webhelpfile": "29383.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 1e-8\u00a0AVoltage: 0.02\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the range for the source for the selected source function.", - "details": "This command manually selects the measurement range for the specified source.To select the range, specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 3\u00a0V, set the source level to 3. The Model 2450 selects the 20\u00a0V range.If you select a specific source range, the range must be large enough to source the value. If not, an overrange condition can occur.If an overrange condition occurs, an event is displayed and the change to the setting is ignored.The fixed current source ranges are 10\u00a0nA, 100\u00a0nA, 1\u00a0\u00b5A, 10\u00a0\u00b5A, 100\u00a0\u00b5A, 1\u00a0mA, 10\u00a0mA, 100\u00a0mA, and 1\u00a0A.The fixed voltage source ranges are 20\u00a0mV, 200\u00a0mV, 2\u00a0V, 20\u00a0V, and 200\u00a0V.When you read this value, the instrument returns the positive full-scale value that the instrument is presently using.This command is intended to eliminate the time required by the automatic range selection.To select the range, you can specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 50\u00a0mV, send 0.05 (or 50e-3) to select the 200\u00a0mV range.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced; see Details for values; the ranges are", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.source.range", - "smu.source.range = rangeValue", - "rangeValue = smu.source.getattribute(function, ATTR_SRC_RANGE)", - "smu.source.setattribute(function, ATTR_SRC_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.OFF;smu.source.range = 1;", - "description": "Set the instrument to source current.\n--- --Turn autorange off.\n--- --Set the source range to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.autorange" - ] - }, - { - "name": "smu.source.autorange", - "webhelpfile": "29386.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the range is selected manually or automatically for the selected source function or voltage source.", - "details": "This command indicates the state of the range for the selected source. When automatic source range is disabled, the source range is set manually.When automatic source range is enabled, the instrument selects the range that is most appropriate for the value that is being sourced. The output level controls the range. If you read the range after the output level is set, the instrument returns the range that the instrument chose as appropriate for that source level.If the source range is set to a specific value from the front panel or a remote command, the setting for automatic range is set to disabled.Only available for the current and voltage functions.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautorangesourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautorangefunction", - "range": "" - } - ], - "usage": [ - "sourceAutorange = smu.source.autorange", - "smu.source.autorange = sourceAutorange", - "sourceAutorange = smu.source.getattribute(function, ATTR_SRC_RANGE_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_RANGE_AUTO, sourceAutorange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.ON;", - "description": "Set the source function to current.\n--- --Set the instrument to select the source range automatically.\n" - } - ], - "related_commands": [ - "smu.source.range" - ] - }, - { - "name": "smu.measure.autorange", - "webhelpfile": "29393.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the measurement range is set manually or automatically for the selected measure function.", - "details": "Autorange selects the best range in which to measure the signal that is applied to the input terminals of the instrument. When autorange is enabled, the range increases at 100 percent of range. The range decreases occur when the reading is <10\u00a0percent of nominal range.This command determines how the range is selected.When this command is set to off, you must set the range. If you do not set the range, the instrument remains at the range that was last selected by autorange.When this command is set to on, the instrument automatically goes to the most sensitive range to perform the measurement.", - "param_info": [ - { - "name": "autoRange", - "description": "Set the measurement range manually", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangeautoRange", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangefunction", - "range": "" - } - ], - "usage": [ - "autoRange = smu.measure.autorange", - "smu.measure.autorange = autoRange", - "autoRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_AUTO)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_AUTO, autoRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n" - } - ], - "related_commands": [ - "smu.measure.range" - ] - }, - { - "name": "smu.measure.range", - "webhelpfile": "29407.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 100e-6Resistance: 200,000Voltage: 0.02\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale measure range.", - "details": "You can assign any real number using this command. The instrument selects the closest fixed range that is large enough to measure the entered number. For example, for current measurements, if you expect a reading of approximately 9\u00a0mA, set the range to 9 mA to select the 10\u00a0mA range. When you read this setting, you see the positive full-scale value of the measurement range that the instrument is presently using.This command is primarily intended to eliminate the time that is required by the instrument to automatically search for a range.When a range is fixed, any signal greater than the entered range generates an overrange condition. When an overrange condition occurs, the front panel displays \"Overflow\" and the remote interface returns 9.9e+37.If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is the same as the source range, regardless of measurement range setting. However, the setting for the measure range is retained, and when the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.If you change the range while the output is off, the instrument does not update the hardware settings, but if you read the range setting, the return is the setting that will be used when the output is turned on. If you set a range while the output is on, the new setting takes effect immediately.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected value to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.measure.range", - "smu.measure.range = rangeValue", - "rangeValue = smu.measure.getattribute(function, ATTR_MEAS_RANGE)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 0.5;", - "description": "Set the source function to current.\n--- --Set the measurement function to voltage.\n--- --Instrument selects the 2 V measurement range.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangelow", - "webhelpfile": "29423.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 10e-9 AVoltage: 20\u00a0mVResistance: 20\u00a0\u03a9\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the lower limit for measurements of the selected function when the range is selected automatically.", - "details": "You can use this command when automatic range selection is enabled. It prevents the instrument from selecting a range that is below this limit. Because the lowest ranges generally require longer settling times, setting the low limit that is appropriate for your application but above the lowest possible range can make measurements require less settling time.The lower limit must be less than the upper limit.Though you can send any value when you send this command, the instrument selects the next highest range value. For example, if you send 15 for the lowest voltage range, the instrument will be set to the 20\u00a0V range as the low limit. If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "lowRange", - "description": "The lower limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangelowfunction", - "range": "" - } - ], - "usage": [ - "lowRange = smu.measure.autorangerangelow", - "smu.measure.autorangerangelow = lowRange", - "lowRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_LOW)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_LOW, lowRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;smu.measure.autorangelow = 2;", - "description": "Sets the low range for voltage measurements to 2\u00a0V.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangehigh", - "webhelpfile": "29432.htm", - "signature": "", - "command_return": "highRange", - "type": "AttributeResistance: (RW)Voltage and current: (R)", - "default_value": "Resistance: 200e6\u00a0\u03a9\n", - "tsp_link": "Yes\n", - "description": "When autorange is selected, this attribute represents the highest measurement range that is used when the instrument selects the measurement range automatically.", - "details": "This command can be written to and read for resistance measurements. For current and voltage measurements, it can only be read.For current and voltage measurements, the upper limit is controlled by the current or voltage limit.For resistance measurements, you can use this command when automatic range selection is enabled to put an upper bound on the range that is used for resistance measurements.The upper limit must be more than the lower limit.If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "highRange", - "description": "The highest measurement range that is used when the range is set automatically", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangehighfunction", - "range": "" - } - ], - "usage": [ - "highRange = smu.measure.autorangehigh", - "smu.measure.autorangehigh = highRange", - "highRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_HIGH)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_HIGH, highRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;print(smu.measure.autorangehigh);", - "description": "Sets the measurement function to voltage and turn autorange on. Check the high range for voltage measurements.\n" - } - ], - "related_commands": [ - "reset()", - "smu.measure.autorange", - "smu.reset()" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "29636.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the instrument to provide an audible signal at a specific frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.Using this function from a remote interface does not affect audible errors or key click settings that were made from the Model 2450 front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the beep (20\u00a0Hz to 8000 Hz)", - "enum": "", - "type": "number", - "range": "(20\u00a0Hz to 8000 Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(2, 2400);", - "description": "Generates a 2 s, 2400\u00a0Hz tone.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "29846.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete (OPC) bit after all pending commands, including overlapped commands, have been executed.", - "details": "This function causes the operation complete bit in the Status Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "smu.measure.limit[Y].enable", - "webhelpfile": "29884.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables a limit test on the measurement from the selected measure function.", - "details": "This command enables or disables a limit test for the selected measurement function. When this attribute is enabled, the limit Y testing occurs on each measurement made by the instrument. Limit Y testing compares the measurements to the high-limit and low-limit values. If a measurement falls outside these limits, the test fails.", - "param_info": [ - { - "name": "state", - "description": "Disable the test", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitenablestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].enable", - "smu.measure.limit[Y].enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.limit[1].enable = smu.ON;", - "description": "Enable testing for limit 1 when measuring voltage.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].clear()", - "smu.measure.limit[Y].fail", - "smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].low.value" - ] - }, - { - "name": "smu.source.level", - "webhelpfile": "29907.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute immediately selects a fixed amplitude for the selected source function.", - "details": "This command sets the output level of the voltage or current source. If the output is on, the new level is sourced immediately.The sign of the source level dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.If a manual source range is selected, the level cannot exceed the specified range. For example, if the voltage source is on the 2\u00a0V range, you cannot set the voltage source level to 3\u00a0V. When autorange is selected, the amplitude can be set to any level supported by the instrument.", - "param_info": [ - { - "name": "sourceLevel", - "description": "Current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcelevelfunction", - "range": "" - } - ], - "usage": [ - "sourceLevel = smu.source.level", - "smu.source.level = sourceLevel", - "sourceLevel = smu.source.getattribute(function, ATTR_SRC_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LEVEL, sourceLevel)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 1;", - "description": "Set the instrument to source voltage and set it to source 1\u00a0V.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.output", - "smu.source.protect.level" - ] - }, - { - "name": "smu.measure.rel.enable", - "webhelpfile": "29986.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the application of a relative offset value to the measurement.", - "details": "When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value calculated when you acquire the relative offset value.Each returned measured relative reading is the result of the following calculation:", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurerelenablerelEnable", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerelenablefunction", - "range": "" - } - ], - "usage": [ - "relEnable = smu.measure.rel.enable", - "smu.measure.rel.enable = relEnable", - "relEnable = smu.measure.getattribute(function, ATTR_MEAS_REL_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_ENABLE, relEnable)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.rel.level", - "webhelpfile": "29987.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the relative offset value.", - "details": "This command specifies the relative offset value that can be applied to new measurements. When relative offset is enabled, all subsequent measured readings are offset by the value that is set for this\u00a0command.You can set this value, or have the instrument acquire a value. If the instrument acquires the value, read this setting to return the value that was measured\u00a0internally.", - "param_info": [ - { - "name": "relValue", - "description": "Relative offset value for measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerellevelfunction", - "range": "" - } - ], - "usage": [ - "relValue = smu.measure.rel.level", - "smu.measure.rel.level = relValue", - "relValue = smu.measure.getattribute(function, ATTR_MEAS_REL_LEVEL)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_LEVEL, relValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.rel.level = smu.measure.read();smu.measure.rel.enable = smu.ON;", - "description": "Sets the measurement function to current, performs a current measurement, uses it as the relative offset value, and enables the relative offset for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.enable" - ] - }, - { - "name": "smu.measure.filter.count", - "webhelpfile": "30064.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements that are averaged when filtering is enabled.", - "details": "The filter count is the number of readings that are acquired and stored in the filter stack for the averaging calculation. When the filter count is larger, more filtering is done, and the data is less noisy.This command is set for the selected function.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltercountfunction", - "range": "" - } - ], - "usage": [ - "filterCount = smu.measure.filter.count", - "smu.measure.filter.count = filterCount", - "filterCount = smu.measure.getattribute(function, ATTR_MEAS_FILTER_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_COUNT, filterCount)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.enable", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.filter.type", - "webhelpfile": "30065.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "smu.FILTER_REPEAT_AVG\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the type of averaging filter that is used for the selected measure function when the measurement filter is enabled.", - "details": "You can select one of two types of averaging filters: repeating average or moving average.When the repeating average filter is selected, a set of measurements are made. These measurements are stored in a measurement stack and averaged together to produce the averaged sample. Once the averaged sample is produced, the stack is flushed, and the next set of data is used to produce the next averaged sample. This type of filter is the slowest, since the stack must be completely filled before an averaged sample can be produced.When the moving average filter is selected, the measurements are added to the stack continuously on a first-in, first-out basis. As each measurement is made, the oldest measurement is removed from the stack. A new averaged sample is produced using the new measurement and the data that is now in the stack.The repeating average filter produces slower results but produces more stable results than the moving average filter. For either method, the greater the number of measurements that are averaged, the slower the averaged sample rate, but the lower the noise error. Trade-offs between speed and noise are normally required to tailor the instrumentation to your measurement application.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled; set to one of the following values", - "enum": "smu.FILTER_MOVING_AVG nil|smu.FILTER_REPEAT_AVG nil", - "type": "smumeasurefiltertypefilterType", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltertypefunction", - "range": "" - } - ], - "usage": [ - "filterType = smu.measure.filter.type", - "smu.measure.filter.type = filterType", - "filterType = smu.measure.getattribute(function, ATTR_MEAS_FILTER_TYPE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_TYPE, filterType)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.enable" - ] - }, - { - "name": "smu.measure.filter.enable", - "webhelpfile": "30066.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the averaging filter for the selected measurement function.", - "details": "This command enables or disables the averaging filter. When this is enabled, the reading returned by the instrument is an averaged value, taken from multiple measurements. The settings of the filter count and filter type for the selected measure function determines how the reading is averaged.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurefilterenablefilterState", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefilterenablefunction", - "range": "" - } - ], - "usage": [ - "filterState = smu.measure.filter.enable", - "smu.measure.filter.enable = filterState", - "filterState = smu.measure.getattribute(function, ATTR_MEAS_FILTER_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_ENABLE, filterState)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.math.mxb.bfactor", - "webhelpfile": "30107.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the offset, b, for the y = mx + b operation.", - "details": "This attribute specifies the offset (b) for an mx + b operation.The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation:Where:", - "param_info": [ - { - "name": "value", - "description": "The offset for the y = mx + b operation; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbbfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.bfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_BF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_BF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx +b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.mfactor" - ] - }, - { - "name": "smu.measure.math.mxb.mfactor", - "webhelpfile": "30108.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the scale factor, m, for the y = mx + b math operation.", - "details": "This command sets the scale factor (m) for an mx + b operation for the selected measurement function.The mx + b math operation lets you manipulate normal display readings (x) mathematically according to the following calculation:Where: ", - "param_info": [ - { - "name": "value", - "description": "The scale factor; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbmfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.mfactor", - "smu.measure.math.mxb.mfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_MF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_MF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx+b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor" - ] - }, - { - "name": "smu.measure.math.percent", - "webhelpfile": "30109.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the reference constant that is used when math operations are set to percent.", - "details": "This is the constant that is used when the math operation is set to percent for the selected measurement function.The percent math function displays measurements as percent deviation from a specified reference constant. The percent calculation is:Where:", - "param_info": [ - { - "name": "value", - "description": "The reference used when the math operation is set to percent; the range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathpercentfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.percent", - "smu.measure.math.percent = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_PERCENT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_PERCENT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.percent = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operations to percent.\n--- --Set the percentage value to 50 for voltage measurements.\n--- --Enable math operations.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.format" - ] - }, - { - "name": "smu.source.protect.tripped", - "webhelpfile": "30235.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the overvoltage source protection feature is active.", - "details": "When overvoltage protection is active, the instrument restricts the maximum voltage level that the instrument can source.", - "param_info": [ - { - "name": "value", - "description": "Overvoltage protection not active", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceprotecttrippedvalue", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotecttrippedfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.protect.tripped", - "value = smu.source.getattribute(function, ATTR_SRC_PROTECT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.protect.tripped);", - "description": "If overvoltage protection is active, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "Overvoltage protection", - "smu.source.protect.level" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "30485.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all readings and statistics from the specified buffer.", - "details": "", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);testData.clear();print(\"Readings in buffer after clear =\" .. testData.n);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);", - "description": "Create a reading buffer named testData, make three readings and store them in testData, and then view the readings.\n--- --Print number of readings in testData.\n--- --Output:\n--- ---4.5010112303956e-10, -3.9923108222095e-12, -4.5013931471161e-10\n--- --Clear the readings in testData.\n--- --Verify that there are no readings in testData.\n--- --Output:\n--- --Readings in buffer after clear = 0\n--- --Store three new readings in testData and view those when complete.\n--- --Output:\n--- --4.923509754e-07, 3.332266330e-07, 3.974883867e-07\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.dates", - "webhelpfile": "30488.htm", - "signature": "bufferVar.dates[N]", - "command_return": "date", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the dates of readings that are stored in the reading buffer.", - "details": "The dates are formatted as month, day, year.This is not available if the reading buffer style is set to compact.", - "param_info": [ - { - "name": "date", - "description": "The date of readings stored in bufferVar element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "date = bufferVar.dates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 1, testData);trigger.model.initiate();waitcomplete();print(testData.dates[1]);printbuffer(1, testData.n, testData.dates);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Example output:\n--- --11/27/2017\n--- --Prints the dates for readings 1 through the last reading in the buffer.\n--- --Example output:\n--- --11/27/2017, 11/27/2017, 11/27/2017\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "30489.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "User-defined buffer: buffer.FILL_ONCE (0)defbuffer1: buffer.FILL_CONTINUOUS (1)defbuffer2: buffer.FILL_CONTINUOUS (1)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if a reading buffer is filled continuously or is filled once and stops.", - "details": "When a reading buffer is set to fill once, no data is overwritten in the buffer. When the buffer is filled, no more data is stored in that buffer and new readings are discarded.When a reading buffer is set to fill continuously, the oldest data is overwritten by the newest data after the buffer fills.When you change the fill mode of a buffer, any data in the buffer is cleared.", - "param_info": [ - { - "name": "fillMode", - "description": "Fill the buffer, then stop", - "enum": "buffer.FILL_ONCE nil|buffer.FILL_CONTINUOUS nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);print(testData.fillmode);testData.fillmode = buffer.FILL_CONTINUOUS;print(testData.fillmode);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer. Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --0\n--- --Set fill mode to continuous. \n--- --Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.digout[N].stimulus", - "webhelpfile": "30501.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line.", - "details": "The digital trigger pulsewidth command determines how long the trigger is asserted.The trigger stimulus for a digital I/O line can be set to one of the trigger events that are described in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "event = trigger.digout[N].stimulus", - "trigger.digout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].stimulus = trigger.EVENT_TIMER3;", - "description": "Set the stimulus for output digital trigger line 2 to be the expiration of trigger timer 3.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()", - "trigger.digout[N].assert()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "30502.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the text from the front-panel USER swipe screen.", - "details": "", - "param_info": [ - { - "name": "display.clear()display.changescreen(display.SCREEN_USER_SWIPE)display.settext(display.TEXT1, \"Serial number:\")display.settext(display.TEXT2, localnode.serialno)", - "description": "Clear the USER swipe screen.Set the first line to read \"Serial number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"Serial number:\");display.settext(display.TEXT2, localnode.serialno);", - "description": "Clear the USER swipe screen.\n--- --Set the first line to read \"Serial number:\" and the second line to display the serial number of the instrument.\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "display.changescreen()", - "webhelpfile": "30503.htm", - "signature": "display.changescreen(screenName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function changes which front-panel screen is displayed.", - "details": "", - "param_info": [ - { - "name": "screenName", - "description": "The screen to display", - "enum": "display.SCREEN_HOME nil|display.SCREEN_HOME_LARGE_READING nil|display.SCREEN_READING_TABLE nil|display.SCREEN_GRAPH nil|display.SCREEN_HISTOGRAM nil|display.SCREEN_GRAPH_SWIPE nil|display.SCREEN_SETTINGS_SWIPE nil|display.SCREEN_SOURCE_SWIPE nil|display.SCREEN_STATS_SWIPE nil|display.SCREEN_USER_SWIPE nil|display.SCREEN_PROCESSING nil", - "type": "displaychangescreenscreenName", - "range": "" - } - ], - "usage": [ - "display.changescreen(screenName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT1, \"Batch A122\");display.settext(display.TEXT2, \"Test running\");display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clear the USER swipe screen.\n--- --Set the first line of the USER swipe screen to read \"Batch A122\" and the second line to display \"Test running\".\n--- --Display the USER swipe screen.\n--- --\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "localnode.showevents", - "webhelpfile": "30504.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (no events sent)\n", - "tsp_link": "No\n", - "description": "This attribute sets whether or not the instrument automatically outputs generated events to the remote interface.", - "details": "Enable this attribute to have the instrument output generated events to the remote interface.Events are output after a command message is executed but before prompts are issued (if prompts are enabled with localnode.prompts).If this attribute is disabled, use eventlog.next() to retrieve unread events from the event log.Events are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable show events when the GPIB connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "errorMode", - "description": "The errors that are returned", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "localnodeshoweventserrorMode", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showevents", - "localnode.showevents = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showevents = eventlog.SEV_ERROR | eventlog.SEV_INFO;trigger.digin[3].edge = trigger.EDGE_EITHER;", - "description": "Send generated error and warning messages.\n--- --Example output if the edge cannot be sent to either:\n--- --1805, Settings conflict: setting input edge when line 3 set for digital\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "localnode.prompts" - ] - }, - { - "name": "smu.measure.count", - "webhelpfile": "30505.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements to make when a measurement is requested.", - "details": "This command sets the number of measurements that are made when a measurement is requested. This command does not affect the trigger model.When smu.measure.count or if the function for smu.measure.setattribute is the active function, this command sets the count for all measure functions. When you send smu.measure.setattribute for a function that is not active, only the count for the specified function is changed.If you set the count to a value that is larger than the capacity of the reading buffer and the buffer fill mode is set to continuous, the buffer wraps until the number of readings specified have occurred. The earliest readings in the count are overwritten. If the buffer is set to fill once, readings stop when the buffer is filled, even if the count is not complete.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements (1 to 300,000 or buffer capacity)", - "enum": "", - "type": "integer", - "range": "(1 to 300,000 or buffer capacity)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurecountfunction", - "range": "" - } - ], - "usage": [ - "count = smu.measure.count", - "smu.measure.count = count", - "count = smu.measure.getattribute(function, ATTR_MEAS_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_COUNT, count)" - ], - "overloads": [], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1;smu.measure.count = 200; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;smu.measure.read(defbuffer1);\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses smu.measure.count to do a capacitor test. This outputs 200 readings that are similar to the following output:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - }, - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example demonstrates how to use the SimpleLoop trigger-model template instead of smu.measure.count to do a capacitor test. Similar to Example 1, this also outputs 200 readings that are similar to the following:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "smu.measure.read()", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.reset()", - "webhelpfile": "30521.htm", - "signature": "smu.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smu. to their default settings.", - "details": "This function turns off the output and resets the commands that begin with smu. to their default settings. It also deletes source and measure configuration lists.", - "param_info": [ - { - "name": "smu.reset()", - "description": "Turns off the output and resets the SMU commands to their default settings.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.reset();", - "description": "Turns off the output and resets the SMU commands to their default settings.\n" - } - ], - "related_commands": [ - "reset()" - ] - }, - { - "name": "status.operation.getmap()", - "webhelpfile": "30523.htm", - "signature": "status.operation.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Operation Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "setEvent, clearEvent = status.operation.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.getmap(0));", - "description": "Query bit 0 of the Operation Event Register.\n--- --Example output:\n--- --4918 4917\n" - } - ], - "related_commands": [ - "Operation Event Register", - "Programmable status register sets", - "status.operation.setmap()" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "30524.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Event Register.", - "details": "This query reads the contents of the questionable status event register. After sending this command and addressing the instrument to talk, a value is sent to the computer. This value indicates which bits in the appropriate register are set.The Questionable Register can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set the Questionable Register to the sum of their decimal weights. For example, to set bits B12 and B13, set the Questionable Register to 12,288 (which is the sum of 4,096\u00a0+\u00a08,192).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the questionable status register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.event" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 66 = binary 0100 0010;questionableRegister = 66;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B1 and B6 of the status questionable enable register.\n" - }, - { - "example": "-- decimal 2560 = binary 00001010 0000 0000;questionableRegister = 2560;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B9 and B11 of the status questionable enable register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "30525.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or sets the bits in the Status Enable register of the Standard Event Register.", - "details": "When a bit in the Status Enable register is set on and the corresponding bit in the Standard Event Status register is set on, the ESB bit of the Status Byte Register is set to on.To set a bit on, send the constant or value of the bit as the standardRegister parameter.You can set the bit as a constant or a numeric value, as shown in the table below. To set more than one bit of the register, you can send multiple constants with + between them. You can also set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B2, set standardRegister to 5 (which is the sum of 1 + 4). You can also send:status.standard.enable = status.standard.OPC + status.standard.QYEWhen zero (0) is returned, no bits are set. You can also send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The value of the Status Enable register of the Standard Event Register (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "standardRegister = status.standard.enable", - "status.standard.enable = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.QYE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and QYE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 5 = binary 0000 0101;standardRegister = 5;status.standard.enable = standardRegister;", - "description": "Uses a decimal value to set the OPC and QYE bits of the standard event status enable register.\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "trigger.timer[N].start.generate", - "webhelpfile": "30536.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies when timer events are generated.", - "details": "When this is set to on, a trigger event is generated immediately when the timer is triggered.When it is set to off, a trigger event is generated when the timer elapses. This generates the event trigger.EVENT_TIMERN.", - "param_info": [ - { - "name": "state", - "description": "Generate a timer event when the timer delay elapses", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerstartgeneratestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.generate", - "trigger.timer[N].start.generate = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;", - "description": "Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "bufferVar.sourceformattedvalues", - "webhelpfile": "30538.htm", - "signature": "bufferVar.sourceformattedvalues[N]", - "command_return": "values", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels formatted as they appear on the front-panel display when the readings in the reading buffer were acquired.", - "details": "The attribute is an array (a Lua table) of the sourced value that was in effect at the time of the reading. The source levels are formatted the same way the readings are formatted when they appear on the front-panel display.", - "param_info": [ - { - "name": "values", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "values = bufferVar.sourceformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 6, 0);trigger.model.initiate();waitcomplete();print(defbuffer1.sourceformattedvalues[1]);printbuffer(1,6,defbuffer1.sourceformattedvalues);", - "description": "Example output:\n--- ---00.00041 mV\n--- --Example output:\n--- ---00.00041 mV, +00.00010 mV, -00.00033 mV, +00.00003 mV, -00.00028 mV, -00.00045 mV\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fractionalseconds", - "webhelpfile": "30542.htm", - "signature": "bufferVar.fractionalseconds[N]", - "command_return": "fractionalSec", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the fractional second portion of the timestamp of each reading in the reading buffer.", - "details": "This read-only attribute is an array of the fractional portion of the timestamp, in seconds, when each reading occurred. Seconds are shown as fractions.", - "param_info": [ - { - "name": "fractionalSec", - "description": "The fractional second portion of the timestamp to 1\u00a0ns resolution", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "fractionalSec = bufferVar.fractionalseconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();print(testData.fractionalseconds[1]);printbuffer(1, 6, testData.fractionalseconds);", - "description": "Create a reading buffer named testData and make six measurements.\n--- --Print the fractional portion of the timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0.647118937\n--- --Print the fractional portion of the timestamp for the first six readings in the buffer.\n--- --Example output:\n--- --0.647118937, 0.064543, 0.48196127, 0.89938724, 0.316800064, 0.734218263\n" - } - ], - "related_commands": [ - "bufferVar.seconds", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "30545.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();for x = 1, 3 do printbuffer(x, x, testData.readings, testData.sourcevalues, testData.relativetimestamps) end;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the three readings in testData, including the measurement, source value, and relative timestamp.\n--- --Output:\n--- ---9.6420389034124e-12, 2, 0\n--- ---4.5509945811872e-10, 2, 0.277194856\n--- ---9.1078204006445e-12, 2, 0.569614783\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "30550.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourceValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "This attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.The values returned by this command depend on the source readback state:", - "param_info": [ - { - "name": "sourceValue", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "sourceValue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.func = smu.FUNC_DC_CURRENT;smu.source.level = 1e-6;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 3, testData.sourcevalues);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source value to 1e-6\u00a0A.\n--- --Print the source values being output when readings in the reading buffer were acquired. \n--- --Example output:\n--- --9.9999874692e-07, 1.0000017028e-06, 1.0000054544e-06\n" - } - ], - "related_commands": [ - "bufferVar.sourcestatuses", - "bufferVar.sourceunits", - "bufferVar.statuses", - "bufferVar.formattedreadings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()", - "smu.source.readback" - ] - }, - { - "name": "tsplink.initialize()", - "webhelpfile": "30551.htm", - "signature": "tsplink.initialize(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes all instruments and enclosures in the TSP-Link system.", - "details": "If the only node on the TSP-Link network is the one running the command and expectedNodes is not provided, this function generates an error event. If you set expectedNodes to 1, the node is initialized.If you include expectedNodes, if nodesFound is less than expectedNodes, an error event is generated.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes found on the system, including the node on which the command is running", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 32)", - "enum": "", - "type": "integer", - "range": "(1 to 32)" - } - ], - "usage": [ - "nodesFound = tsplink.initialize()", - "nodesFound = tsplink.initialize(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.initialize()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.initialize(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link initialization and indicate how many nodes are found.\n--- --Example output if two nodes are found:Nodes found = 2\n--- --Example output if fewer nodes are found and if localnode.showevents = 7:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "related_commands": [ - "Initializing the TSP-Link system", - "localnode.showevents", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "eventlog.getcount()", - "webhelpfile": "30552.htm", - "signature": "eventlog.getcount(eventType)", - "command_return": "count", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of unread events in the event log.", - "details": "A count finds the number of unread events in the event log. You can specify the event types to return or return the count for all events.This command reports the number of events that have occurred since the command was last sent or since the event log was last cleared.Events are read automatically when localnode.showevents is enabled. You can also read them individually with eventlog.next().", - "param_info": [ - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventloggetcounteventType", - "range": "" - }, - { - "name": "count", - "description": "A count finds the number of unread events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = eventlog.getcount()", - "count = eventlog.getcount(eventType)" - ], - "overloads": [ - "count = eventlog.getcount()" - ], - "examples": [ - { - "example": "print(eventlog.getcount(eventlog.SEV_INFO));", - "description": "Displays the present number of unread information messages in the instrument event log.\n--- --If there are three information messages in the event log, output is:\n--- --3\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.next()", - "localnode.showevents" - ] - }, - { - "name": "trigger.timer[N].start.overrun", - "webhelpfile": "30553.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.", - "param_info": [ - { - "name": "state", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].start.overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].start.stimulus", - "webhelpfile": "30555.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the event that starts the trigger timer.", - "details": "Set the stimulus to any trigger event to start the timer when that event occurs.Set the stimulus to none to disable event processing and use the timer as a timer or alarm based on the start time.Trigger events are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event that starts the trigger timer; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.timer[N].start.stimulus", - "trigger.timer[N].start.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;trigger.timer[1].delay = 3e-3;trigger.timer[1].start.stimulus = trigger.EVENT_DIGIO3;", - "description": "Set digital I/O line 3 to be a trigger input.\n--- --Set timer 1 to delay for 3\u00a0ms.\n--- --Set timer 1 to start the timer when an event is detected on digital I/O line 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.configlist.store()", - "webhelpfile": "30559.htm", - "signature": "smu.measure.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active measure settings into the named configuration list.", - "details": "Use this command to store the active measure settings to a configuration index in a configuration list. If the index parameter is not provided, the new settings are appended to the end of the list. The index only stores the active settings for a single active measure function.Configuration lists are not saved when the instrument is turned off or reset. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Refer to Settings stored in a measure configuration index for a complete list of measure settings that the instrument stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.store(listName)", - "smu.measure.configlist.store(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.store(\"MyConfigList\");", - "description": "Stores the active settings of the instrument to the end of the configuration list MyConfigList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.unit", - "webhelpfile": "30560.htm", - "signature": "", - "command_return": "unitOfMeasure", - "type": "Attribute (RW)", - "default_value": "Current: smu.UNIT_AMPResistance: smu.UNIT_OHMVoltage: smu.UNIT_VOLT\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.", - "details": "The change in measurement units is displayed when the next measurement is made.", - "param_info": [ - { - "name": "unitOfMeasure", - "description": "The units of measure to be displayed for the measurement", - "enum": "smu.UNIT_AMP nil|smu.UNIT_OHM nil|smu.UNIT_VOLT nil|smu.UNIT_WATT nil", - "type": "smumeasureunitunitOfMeasure", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureunitfunction", - "range": "" - } - ], - "usage": [ - "unitOfMeasure = smu.measure.unit", - "smu.measure.unit = unitOfMeasure", - "unitOfMeasure = smu.measure.getattribute(function, ATTR_MEAS_UNIT)", - "smu.measure.setattribute(function, ATTR_MEAS_UNIT, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.unit = smu.UNIT_WATT;", - "description": "Changes the front-panel display and buffer readings for voltage measurements to be displayed as power readings in watts.\n" - } - ], - "related_commands": [ - "smu.measure.func" - ] - }, - { - "name": "smu.source.ilimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 1.05E-4\u00a0ACurrent: 21\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2450 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.ilimit.level", - "smu.source.ilimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.vlimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 1.05E-4\u00a0ACurrent: 21\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2450 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.vlimit.level", - "smu.source.vlimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.ilimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.ilimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.vlimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.vlimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.sweeplinear()", - "webhelpfile": "30563.htm", - "signature": "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear sweep for a fixed number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears any existing trigger models, creates a source configuration list, and populates the trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10\u00a0ms for the source delay and 25\u00a0ms for the sweep delay, the actual delay is 35\u00a0ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. ", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50\u00a0\u00b5s to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearrangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplineardual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.source.sweeplinear(\"VoltLinSweep\", 0, 10, 20, 1e-3, 1, smu.RANGE_FIXED);smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set up a linear sweep that sweeps from 0 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLinSweep.\n--- --Set the measure function to current.\n--- --Set the current range to 100 \u03bcA.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "smu.source.sweeplinearstep()", - "webhelpfile": "30565.htm", - "signature": "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear source sweep configuration list and trigger model with a fixed number of steps.", - "details": "When the sweep is started, the instrument sources a specific voltage or current voltage to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it deletes the existing trigger model and creates a trigger model with a uniform series of ascending or descending voltage or current changes, called steps. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the stop level, which is calculated from the number of steps. A measurement is performed at each source step (including the start and stop levels). At this level, the instrument performs another measurement and then stops the sweep.The instrument uses the step size parameter to determine the number of source level changes. The source level changes in equal steps from the start level to the stop level. To avoid a setting conflicts error, make sure the step size is greater than the start value and less than the stop value. To calculate the number of source-measure points in a sweep, use the following formula: Points = [(Stop - Start) / Step] + 1When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "step", - "description": "The step size at which the source level will change; must be more than 0", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearstepsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearstepcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearsteprangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 1;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;smu.source.sweeplinearstep(\"CurrLogSweep\", -1.05, 1.05, .25, 10e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to current.\n--- --Set the source range to 1\u00a0A. Set the measure function to voltage with a range of 20\u00a0V.\n--- --Set up a linear step sweep that sweeps from -1.05\u00a0A to 1.05\u00a0A in 0.25\u00a0A increments with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep CurrLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.sweeplog()", - "webhelpfile": "30566.htm", - "signature": "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a logarithmic sweep for a set number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears the existing trigger model and creates a new trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. The asymptote changes the inflection of the sweep curve and allows it to sweep through zero. You can use the asymptote parameter to customize the inflection and offset of the source value curve. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep. The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplogsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplogcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplograngeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "asymptote", - "description": "Default is 0; see Details", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)" - ], - "overloads": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;smu.source.sweeplog(\"VoltLogSweep\", 1, 10, 20, 1e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set the measure function to current.\n--- --Set the current range to 100 uA.\n--- --Set up a log sweep that sweeps from 1 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.clear()", - "webhelpfile": "30567.htm", - "signature": "status.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears event registers.", - "details": "This command clears the event registers of the Questionable Event and Operation Event Register set. It does not affect the Questionable Event Enable or Operation Event Enable registers.", - "param_info": [ - { - "name": "status.clear()", - "description": "Clear the bits in the registers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "status.clear();", - "description": "Clear the bits in the registers\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.getblocklist()", - "webhelpfile": "30569.htm", - "signature": "trigger.model.getblocklist()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the settings for all trigger model blocks.", - "details": "This returns the settings for the trigger model.", - "param_info": [ - { - "name": "output", - "description": "Returns the settings for the trigger model", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getblocklist()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.getblocklist());", - "description": "Returns the settings for the trigger model. Example output is:\n--- -- 1) BUFFER_CLEAR BUFFER: defbuffer1\n--- -- 2) MEASURE BUFFER: defbuffer1 COUNT: 1\n--- -- 3) BRANCH_COUNTER VALUE: 5 BRANCH_BLOCK: 2\n--- -- 4) DELAY_CONSTANT DELAY: 1.000000000\n--- -- 5) BRANCH_COUNTER VALUE: 3 BRANCH_BLOCK: 2\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()" - ] - }, - { - "name": "trigger.model.getbranchcount()", - "webhelpfile": "30570.htm", - "signature": "trigger.model.getbranchcount(blockNumber)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the count value of the trigger model counter block.", - "details": "This command returns the counter value. When the counter is active, this returns the present count. If the trigger model has started or is running but has not yet reached the counter block, this value is 0.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "output", - "description": "Returns the count value of the trigger model counter block.", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getbranchcount(blockNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 0.1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);trigger.model.initiate();delay(1);print(trigger.model.getbranchcount(4));waitcomplete();", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and make five readings.\n--- --Delay 0.1 s.\n--- --Loop ten more times back to block 2.\n--- --Send the count command to check which count has been completed for block 4.\n--- --At end of execution, 10 readings are stored in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.initiate()", - "webhelpfile": "30571.htm", - "signature": "trigger.model.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function starts the trigger model.", - "details": "", - "param_info": [], - "usage": [ - "trigger.model.initiate()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.model.abort()" - ] - }, - { - "name": " trigger.BLOCK_BUFFER_CLEAR", - "webhelpfile": "30574.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that clears the reading buffer.", - "details": "When trigger model execution reaches the buffer clear trigger block, the instrument empties the specified reading buffer. The specified buffer can be the default buffer or a buffer that you defined.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_BUFFER_CLEAR, capTest2);", - "description": "Assign trigger block 3 to buffer clear; when the trigger model reaches block 3, it clears the reading buffer named capTest2.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Buffer clear block" - ] - }, - { - "name": "trigger.timer[N].enable", - "webhelpfile": "30576.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables the trigger timer.", - "details": "When this command is set to on, the timer performs the delay operation.When this command is set to off, there is no timer on the delay operation.You must enable a timer before it can use the delay settings or the alarm configuration. For expected results from the timer, it is best to disable the timer before changing a timer setting, such as delay or start seconds.To use the timer as a simple delay or pulse generator with digital I/O lines, make sure the timer start time in seconds and fractional seconds is configured for a time in the past. To use the timer as an alarm, configure the timer start time in seconds and fractional seconds for the desired alarm time.", - "param_info": [ - { - "name": "state", - "description": "Disable the trigger timer", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerenablestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].enable", - "trigger.timer[N].enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].enable = trigger.ON;", - "description": "Enable the trigger timer for timer 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.logstate", - "webhelpfile": "30577.htm", - "signature": "bufferVar.logstate", - "command_return": "logState", - "type": "Attribute (RW)", - "default_value": "defbuffer1: buffer.ON (1)defbuffer2: buffer.ON (1)User-created buffer: buffer.OFF (0)\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if information events are logged when the specified reading buffer is at 0% or 100% filled.", - "details": "If this is set to on, when the reading buffer is cleared (0% filled) or full (100% filled), an event is logged in the event log. If this is set to off, reading buffer status is not reported in the event log.", - "param_info": [ - { - "name": "logState", - "description": "Do not log information events", - "enum": "buffer.OFF nil|buffer.ON nil", - "type": "bufferVarlogstatelogState", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "logState = bufferVar.logstate", - "bufferVar.logstate = logState" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;MyBuffer = buffer.make(500);print(MyBuffer.logstate);", - "description": "Create the user-defined buffer MyBuffer.\n--- --Print the log state of MyBuffer.\n--- --Output:\n--- --0\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.readback", - "webhelpfile": "30579.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument records the measured source value or the configured source value when making a measurement.", - "details": "When source readback is off, the instrument records and displays the source value you set. When you use the actual source value (source readback on), the instrument measures the actual source value immediately before making the measurement of the device under test.Using source readback results in more accurate measurements, but also a reduction in measurement speed.When source readback is on, the front-panel display shows the measured source value and the buffer records the measured source value immediately before the device-under-test measurement. When source readback is off, the front-panel display shows the configured source value and the buffer records the configured source value immediately before the device-under-test measurement.", - "param_info": [ - { - "name": "state", - "description": "Disable readback", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcereadbackstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcereadbackfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.readback", - "smu.source.readback = state", - "state = smu.source.getattribute(function, ATTR_SRC_READBACK)", - "smu.source.setattribute(function, ATTR_SRC_READBACK, state)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testDataBuffer = buffer.make(100);smu.source.func = smu.FUNC_DC_VOLTAGE;smu.measure.func = smu.FUNC_DC_CURRENT;smu.source.readback = smu.ON;smu.source.level = 10;smu.measure.count = 100;smu.source.output = smu.ON;smu.measure.read(testDataBuffer);smu.source.output = smu.OFF;printbuffer(1, 100, testDataBuffer.sourcevalues, testDataBuffer);", - "description": "Reset the instrument to default settings.\n--- --Make a buffer named testDataBuffer that can hold 100 readings.\n--- --Set source function to voltage.\n--- --Set the measurement function to current.\n--- --Set read back on.\n--- --Set the instrument to take 100 readings.\n--- --Turn the output on.\n--- --Take the measurements.\n--- --Turn the output off.\n--- --Get the source values and measurements from the buffer.\n" - } - ], - "related_commands": [ - "smu.measure.func", - "smu.source.func" - ] - }, - { - "name": "smu.source.highc", - "webhelpfile": "30580.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When the instrument is measuring low current and is driving a capacitive load, you may see overshoot, ringing, and instability. You can enable the high capacitance mode to minimize these problems.", - "param_info": [ - { - "name": "state", - "description": "Turn high-capacitance mode off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcehighcstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcehighcfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.highc", - "smu.source.highc = state", - "state = smu.source.getattribute(function, ATTR_SRC_HIGHC)", - "smu.source.setattribute(function, ATTR_SRC_HIGHC, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.highc = smu.ON;", - "description": "Turn the high capacitance mode on.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - DurationLoop", - "webhelpfile": "30588.htm", - "signature": "trigger.model.load(DurationLoop, duration, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements for a specified amount of time.", - "details": "When you load this trigger-model template, you can specify amount of time to make a measurement and the length of the delay before the measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "DurationLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "duration", - "description": "The amount of time for which to make measurements (167 ns to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(167 ns to 100\u00a0ks)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)", - "trigger.model.load(DurationLoop, duration, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 5; ;-- Turn on output, initiate readings, and store them in defbuffer1;trigger.model.load(\"DurationLoop\", 10, 0.01, defbuffer1);trigger.model.initiate();", - "description": "Reset the instrument. Set the instrument to source voltage at 5\u00a0V. Set to measure current.\n--- --Load the duration loop trigger model to take measurements for 10 s with a 10\u00a0ms delay before each measurement.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "30981.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines.", - "details": "This function writes to the digital I/O port by setting the binary state of each digital line from an integer equivalent value.The binary representation of the value indicates the output pattern to be written to the I/O port. For example, a value of 63 has a binary equivalent of 111111 (all lines are set high); a data value of 42 has a binary equivalent of 101010 (lines 2, 4, and 6 are set high, and the other three lines are set low).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.You can also enter the data parameter as a binary value.", - "param_info": [ - { - "name": "data", - "description": "The value to write to the port (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(63);", - "description": "Sets digital I/O lines 1 through 6 high (binary 111111).\n" - }, - { - "example": "digio.writeport(0b111111);", - "description": "Sets digital I/O lines 1 through 6 high (digital\u00a063).\n" - } - ], - "related_commands": [ - "digio.readport()", - "Outputting a bit pattern" - ] - }, - { - "name": "digio.line[N].state", - "webhelpfile": "30982.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low when the line is set for digital control and returns the state on the digital I/O lines.", - "details": "When a reset occurs, the digital line state can be read as high because the digital line is reset to a digital input. A digital input floats high if nothing is connected to the digital line.This returns the integer equivalent values of the binary states on all six digital I/O lines.Set the state to digio.STATE_LOW to clear the bit; set the state to digio.STATE_HIGH to set the bit.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "state", - "description": "Set the line low", - "enum": "digio.STATE_LOW nil|digio.STATE_HIGH nil", - "type": "digiolinestatestate", - "range": "" - } - ], - "usage": [ - "digio.line[N].state = state", - "state = digio.line[N].state" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_DIGITAL_OUT;digio.line[1].state = digio.STATE_HIGH;", - "description": "Sets line 1 (bit B1) of the digital I/O port high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.readport()", - "digio.writeport()", - "trigger.digin[N].edge" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "31076.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger timer settings to their default values.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their default values:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 to their default values.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].enable", - "trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.generate", - "trigger.timer[N].start.overrun", - "trigger.timer[N].start.seconds", - "trigger.timer[N].start.stimulus" - ] - }, - { - "name": " trigger.BLOCK_WAIT", - "webhelpfile": "31093.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that waits for an event before allowing the trigger model to continue.", - "details": "The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger block allows trigger execution to continue (see Details)", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "(see Details)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITclear", - "range": "" - }, - { - "name": "logic", - "description": "If each event must occur before the trigger model continues", - "enum": "trigger.WAIT_AND nil|trigger.WAIT_OR nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITlogic", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)" - ], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);", - "description": "Set trigger model block 9 to wait for a user to press the TRIGGER key on the front panel before continuing.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_MEASURE_DIGITIZE", - "webhelpfile": "31094.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that makes or digitizes a measurement.", - "details": "Digitized measurements are not a feature on the Model 2450. However, you can use this command to communicate with other Keithley instruments that do offer the digitized measurements feature and to share code with other Keithley instruments.Firmware versions of the Model 2450 before version 1.7.0 had a separate measure block. If you have code that is using that block, it works in this version of the Model 2450 firmware.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "count", - "description": "The number of measure or digitize readings to make before moving to the next block in the trigger model; set to", - "enum": "trigger.COUNT_INFINITE nil|trigger.COUNT_STOP nil|trigger.COUNT_AUTO nil", - "type": "triggermodelsetblocktriggerBLOCK_MEASURE_DIGITIZEcount", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set the function to measure DC voltage.\n--- --Set block 1 to clear defbuffer1.\n--- --Set block 2 to set a delay of 0.\n--- --Set block 3 to make measurements infinitely.\n--- --Set block 4 to wait until the front-panel TRIGGER key is pressed.\n--- --Set block 5 to stop making measurements.\n--- --Set block 6 to send a notification.\n--- --Start the trigger model.\n--- --You must press the front-panel TRIGGER key to stop measurements.\n--- --Output the number of readings.\n" - }, - { - "example": "reset();smu.measure.configlist.create(\"countactive\");smu.measure.count = 2;smu.measure.configlist.store(\"countactive\") -- index1;smu.measure.count = 10;smu.measure.configlist.store(\"countactive\") -- index2;smu.measure.count = 3;smu.measure.configlist.store(\"countactive\") -- index3;\u00a0;trigger.model.setblock(1, trigger.BLOCK_CONFIG_NEXT, \"countactive\");trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_AUTO);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 3, 1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set up a configuration list named countactive.\n--- --Set the measure count to 2 (replace smu.measure.count with smu.digitize.count if using a digitize function.)\n--- --Store the count in index 1.\n--- --Set the measure count to 10.\n--- --Store the count in index 2.\n--- --Set the measure count to 3.\n--- --Store the count in index 3.\n--- --Set up trigger model block 1 to call the next index from the countactive configuration list.\n--- --Set block 2 to measure or digitize and store the readings in defbuffer1, using the most recent count value.\n--- --Set block 3 to add a delay of 1\u00a0s.\n--- --Set block 4 to iterate through the trigger model 3 times, returning to block 1.\n--- --Start the trigger model.\n--- --Output the number of readings. There should be 15 readings.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Measure/Digitize block" - ] - }, - { - "name": " trigger.BLOCK_SOURCE_OUTPUT", - "webhelpfile": "31095.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that turns the output source on or off.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "Turn the source off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "triggermodelsetblocktriggerBLOCK_SOURCE_OUTPUTstate", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);", - "description": "Set trigger model to turn the source on when it reaches block 2.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_RECALL", - "webhelpfile": "31096.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the system settings that are stored in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.When the trigger model reaches a configuration recall block, the settings in the specified configuration list are recalled if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are recalled from the next index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.You can restore a specific set of configuration settings in the configuration list by defining the index.If you need to swap the source and measure configuration lists, you need to delete this block and create a new Config List Recall block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list to recall; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalIndex", - "description": "The index to recall from the second configuration list; defaults to 1", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5);", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5,; \"sourTrigList\") ;print(trigger.model.getblocklist());", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList and load index 1 from the configuration list name sourTrigList.\n--- --Query the configuration of the block.\n--- --Output:\n--- --5) CONFIG_RECALL CONFIG_LIST: measTrigList and sourTrigList INDEX: 5 and 1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_NEXT", - "webhelpfile": "31097.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the settings at the next index of a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "The name of the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");", - "description": "Configure trigger block 5 to load the next index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\");trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 1 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 1\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_NEXT CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the next index in both the configuration list named measTrigList and the configuration list named sourTrigList. \n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_PREV", - "webhelpfile": "31098.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.The Config List Prev block defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are each recalled from the previous index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.The configuration list previous index trigger block type recalls the previous index in a configuration list. It configures the source or measure settings of the instrument based on the settings at that index. The trigger model executes the settings at that index before the next block is executed.The first time the trigger model encounters this block, the last index in the configuration list is recalled if the list has not already had an index recalled by the recall block command in an earlier trigger model block. If the configuration list has recalled an index with the recall block, the previous index in the list is called instead of the last. For example, the recall block recalls index 1 by default, so if the trigger model uses a recall block before this one, the first time the previous block is reached after that recall, the last index is recalled. However, if the recall block recalled index 3, the previous block would recall index 2. Each subsequent time trigger model execution reaches a configuration list previous block for this configuration list, it goes backward one index. When the first index in the list is reached, it goes to the last index in the configuration list.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(8, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");", - "description": "Configure trigger block 8 to load the previous index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 3);trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 3 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Then, recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 3\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_PREV CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_PREV, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the previous index in both the configuration list named measTrigList and the configuration list named sourTrigList.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_DELAY_DYNAMIC", - "webhelpfile": "31101.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a user delay to the execution of the trigger model.", - "details": "Each measure function can have up to five unique user delay times (M1 to M5). Each source function can also have up to five unique user delay times (S1 to S5). The delay time is set by the user-delay command, which is only available over a remote interface. Though the trigger model can be used with any function, the user delay is set per function. Make sure you are setting the delay for the function you intend to use with the trigger model.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "userDelay", - "description": "The number of the user delay", - "enum": "trigger.USER_DELAY_M nil|trigger.USER_DELAY_S nil", - "type": "triggermodelsetblocktriggerBLOCK_DELAY_DYNAMICuserDelay", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "smu.measure.userdelay[N]", - "smu.source.userdelay[N]" - ] - }, - { - "name": " trigger.BLOCK_DIGITAL_IO", - "webhelpfile": "31102.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that sets the lines on the digital I/O port high or low.", - "details": "The bit mask defines the bits in the pattern that are driven high or low. A binary 1 in the bit mask indicates that the corresponding I/O line should be driven according to the bit pattern. To drive all lines, specify all ones (63, 0x3F, 0b111111) or omit this parameter. If the bit for a line in the bit pattern is set to 1, the line is driven high. If the bit is set to 0 in the bit pattern, the line is driven low.For this block to work as expected, make sure you configure the trigger type and line state of the digital line for use with the trigger model (use the digital line mode command).", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bitPattern", - "description": "Sets the value that specifies the output line bit pattern (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - }, - { - "name": "bitMask", - "description": "Specifies the bit mask; if omitted, all lines are driven (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)" - ], - "overloads": [], - "examples": [ - { - "example": "for x = 3, 6 do digio.line[x].mode = digio.MODE_DIGITAL_OUT end;trigger.model.setblock(4, trigger.BLOCK_DIGITAL_IO, 20, 60);", - "description": "The for loop configures digital I./O lines 3 through 6 as digital outputs. Trigger block 4 is then configured with a bit pattern of 20 (digital I/O lines 3 and 5 high). The optional bit mask is specified as 60 (lines 3 through 6), so both lines 3 and 5 are driven high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_COUNTER", - "webhelpfile": "31103.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that branches to a specified block a specified number of times.", - "details": "This command defines a trigger model building block that branches to another block using a counter to iterate a specified number of times.Counters increment every time the trigger model reaches them until they are more than or equal to the count value. At that point, the trigger model continues to the next building block in the sequence.The counter is reset to 0 when the trigger model starts. It is incremented each time trigger model execution reaches the counter block.If you are using remote commands, you can query the counter. The counter is incremented immediately before the branch compares the actual counter value to the set counter value. Therefore, the counter is at 0 until the first comparison. When the trigger model reaches the set counter value, branching stops and the counter value is one greater than the setting. Use trigger.model.getbranchcount() to query the counter.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetCount", - "description": "The number of times to repeat", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the counter is less than the targetCount value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);print(trigger.model.getbranchcount(4));", - "description": "When the trigger model reaches this block, the trigger model returns to block 2. This repeats 10 times.\n--- --An example of the return if the trigger model has reached this block 5 times is:\n--- --5\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_RESET_BRANCH_COUNT" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ON_EVENT", - "webhelpfile": "31104.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function branches to a specified block when a specified trigger event occurs.", - "details": "If you are using a timer, it must be started before it can expire. One method to start the timer in the trigger model is to include a Notify block before the On Event block. Set the Notify block to use the same timer as the On Event block.The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger model branches the specified block", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the specified event occurs", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ON_EVENT, trigger.EVENT_DISPLAY, 2);", - "description": "When the trigger model reaches this block, if the front-panel TRIGGER key has been pressed, the trigger model returns to block 2. If the TRIGGER key has not been pressed, the trigger model continues to block 7 (the next block in the trigger model).\n" - } - ], - "related_commands": [ - "On event block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_CONSTANT", - "webhelpfile": "31105.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if a measurement meets preset criteria.", - "details": "The type of limit can be:The measurement block must be a measure/digitize block that occurs in the trigger model before the branch-on-constant-limits block. The last measurement from a measure/digitize block is used.If the limit A is more than the limit B, the values are automatically swapped so that the lesser value is used as the lower limit.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitType", - "range": "" - }, - { - "name": "limitA", - "description": "The lower limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitA", - "range": "" - }, - { - "name": "limitB", - "description": "The upper limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitB", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the defined criteria", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, trigger.LIMIT_ABOVE, 0.1, 1, 2);", - "description": "Sets trigger block 5 to be a constant limit that branches to block 2 when the measurement is above the value set for limit B (which is set to 1). Note that limit A must be set but is ignored. \n" - } - ], - "related_commands": [ - "Constant Limit block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_DELTA", - "webhelpfile": "31107.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.", - "details": "This block calculates the difference between the last two measurements from a measure/digitize block. It subtracts the most recent measurement from the previous measurement.The difference between the measurements is compared to the target difference. If the difference is less than the target difference, the trigger model goes to the specified branching block. If the difference is more than the target difference, the trigger model proceeds to the next block in the trigger block sequence.If you do not define the measure/digitize block, it will compare measurements of a measure/digitize block that precedes the branch delta block. For example, if you have a measure/digitize block, a wait block, another measure/digitize block, another wait block, and then the branch delta block, the delta block compares the measurements from the second measure/digitize block. If a preceding measure/digitize block does not exist, an error occurs.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetDifference", - "description": "The value against which the block compares the difference between the measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the difference between the measurements is less than or equal to the targetDifference", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_DELTA, 0.35, 8, 3);", - "description": "Configure trigger block 5 to branch to block 8 when the measurement difference from block 3 is less than 0.35.\n" - } - ], - "related_commands": [ - "Delta block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE", - "webhelpfile": "31108.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.", - "details": "The branch-once building block branches to a specified block the first time trigger model execution encounters the branch-once block. If it is encountered again, the trigger model ignores the block and continues in the normal sequence.The once block is reset when trigger model execution reaches the idle state. Therefore, the branch-once block always executes the first time the trigger model execution encounters this block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model first encounters this block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE, 4);", - "description": "When the trigger model reaches block 2, the trigger model goes to block 4 instead of going in the default sequence of block 3.\n" - } - ], - "related_commands": [ - "Once block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE_EXCLUDED", - "webhelpfile": "31109.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.", - "details": "The branch-once-excluded block is ignored the first time the trigger model encounters it. After the first encounter, the trigger model goes to the specified branching block.The branch-once-excluded block is reset when the trigger model starts or is placed in idle.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model encounters this block after the first encounter", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, 4);", - "description": "When the trigger model reaches block 2 the first time, the trigger model goes to block 3. If the trigger model reaches this block again, the trigger model goes to block 4.\n" - } - ], - "related_commands": [ - "Once excluded block" - ] - }, - { - "name": " trigger.BLOCK_NOTIFY", - "webhelpfile": "31110.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that generates a trigger event and immediately continues to the next block.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "The identification number of the notification; 1 to 8", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.model.setblock(5, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY2);trigger.digout[3].stimulus = trigger.EVENT_NOTIFY2;", - "description": "Define trigger model block 5 to be the notify 2 event. Assign the notify 2 event to be the stimulus for digital output line 3.\n" - } - ], - "related_commands": [ - "Notify block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ALWAYS", - "webhelpfile": "31112.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that always goes to a specific block.", - "details": "When the trigger model reaches a branch-always building block, it goes to the building block set by branchToBlock.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number to execute when the trigger model reaches the Branch Always block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ALWAYS, 20);", - "description": "When the trigger model reaches block 6, always branch to block 20.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_DYNAMIC", - "webhelpfile": "31114.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.", - "details": "The measure/digitize block must occur in the trigger model before the branch-on-dynamic-limits block. If no block is defined, the measurement from the previous measure/digitize block is used. If no previous measure/digitize block exists, an error is reported.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_DYNAMIClimitType", - "range": "" - }, - { - "name": "limitNumber", - "description": "The limit number (1 or 2)", - "enum": "", - "type": "1|2", - "range": "(1 or 2)" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the criteria set in the configuration list", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, trigger.LIMIT_OUTSIDE, 2, 10, 5);", - "description": "Configure block 7 to check if limit 2 is outside its limit values, based on the measurements made in block 5. If values are outside the measurements, branch to block 10. If the values are not outside the measurements, trigger model execution continues to block 8.\n" - } - ], - "related_commands": [ - "Dynamic Limit block", - "smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].high.value" - ] - }, - { - "name": " trigger.BLOCK_DELAY_CONSTANT", - "webhelpfile": "31347.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a constant delay to the execution of a trigger model.", - "details": "When trigger model execution reaches a delay block, it stops normal measurement and trigger model operation for the time set by the delay. Background measurements continue to be made, and if any previously executed block started infinite measurements, they also continue to be made.If other delays have been set, this delay is in addition to the other delays.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "time", - "description": "The amount of time to delay in seconds (167 ns to 10 ks, or 0 for no delay)", - "enum": "", - "type": "number", - "range": "(167 ns to 10 ks, or 0 for no delay)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_DELAY_CONSTANT, 30e-3);", - "description": "Configure trigger block 7 to delay the trigger model before the next block until a delay of 30 ms elapses.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digin[N].edge", - "webhelpfile": "31360.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the edge used by the trigger event detector on the given trigger line.", - "details": "This command sets the logic on which the trigger event detector and the output trigger generator operate on the specified trigger line.To directly control the line state, set the mode of the line to digital and use the write command. When the digital line mode is set for open drain, the edge settings assert a TTL low-pulse.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger logic value", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggerdiginedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "detectedEdge = trigger.digin[N].edge", - "trigger.digin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;trigger.digin[4].edge = trigger.EDGE_RISING;", - "description": "Sets the trigger mode for digital I/O line\u00a04 to detect a rising-edge trigger as an input.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "digio.writeport()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "digio.line[N].mode", - "webhelpfile": "31363.htm", - "signature": "", - "command_return": "lineMode", - "type": "Attribute (RW)", - "default_value": "digio.MODE_DIGITAL_IN\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode of the digital I/O line to be a digital line, trigger line, or synchronous line and sets the line to be input, output, or open-drain.", - "details": "", - "param_info": [ - { - "name": "lineMode", - "description": "The digital line control type and line mode", - "enum": "digio.MODE_DIGITAL_IN nil|digio.MODE_DIGITAL_OUT nil|digio.MODE_DIGITAL_OPEN_DRAIN nil|digio.MODE_TRIGGER_IN nil|digio.MODE_TRIGGER_OUT nil|digio.MODE_TRIGGER_OPEN_DRAIN nil|digio.MODE_SYNCHRONOUS_MASTER nil|digio.MODE_SYNCHRONOUS_ACCEPTOR nil", - "type": "digiolinemodelineMode", - "range": "" - }, - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "lineMode = digio.line[N].mode", - "digio.line[N].mode = lineMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_TRIGGER_OUT;", - "description": "Set digital I/O line 1 to be an output trigger line.\n" - } - ], - "related_commands": [ - "trigger.digin[N].edge" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "31368.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the digital I/O port. The least significant bit (bit B1) of the binary number corresponds to digital I/O line 1; bit B6 corresponds to digital I/O line 6.For example, a returned value of 42 has a binary equivalent of 101010, which indicates that lines 2, 4, 6 are high (1), and the other lines are low (0).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, and 6 are set high when the I/O port is read.\n--- --Output:\n--- --42\n--- --This is binary 101010\n" - } - ], - "related_commands": [ - "digio.writeport()" - ] - }, - { - "name": "trigger.digin[N].clear()", - "webhelpfile": "31373.htm", - "signature": "trigger.digin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital input line.", - "details": "The event detector of a trigger enters the detected state when an event is detected. For the specified trigger line, this command clears the event detector, discards the history, and clears the overrun status(sets the overrun status to false).", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.digin[2].clear();", - "description": "Clears the trigger event detector on I/O line\u00a02.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digin[N].wait()" - ] - }, - { - "name": "trigger.digin[N].overrun", - "webhelpfile": "31378.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "overrun = trigger.digin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.digin[1].overrun;print(overrun);", - "description": "If there is no trigger overrun on digital input\u00a01, the output is:\n--- --false\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].pulsewidth", - "webhelpfile": "31385.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0us)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use trigger.digout[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "width = trigger.digout[N].pulsewidth", - "trigger.digout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digout[N].assert()", - "trigger.digout[N].release()" - ] - }, - { - "name": "trigger.digout[N].assert()", - "webhelpfile": "31392.htm", - "signature": "trigger.digout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines.", - "details": "Initiates a trigger event and does not wait for completion. The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].pulsewidth = 20e-6;trigger.digout[2].assert();", - "description": "Asserts a trigger on digital I/O line 2 with a pulse width of 20\u00a0us.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "digio.line[N].reset()", - "webhelpfile": "31393.htm", - "signature": "digio.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets digital I/O line values to their factory defaults.", - "details": "This function resets the following attributes to their default values:It also clears trigger.digin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "digio.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "-- Set the digital I/O trigger line 3 for a falling edge;digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.digout[3].logic = trigger.LOGIC_NEGATIVE;-- Set the digital I/O trigger line 3 to have a pulsewidth of 50 microseconds.;trigger.digout[3].pulsewidth = 50e-6;-- Use digital I/O line 5 to trigger the event on line 3.;trigger.digout[3].stimulus = trigger.EVENT_DIGIO5;-- Print configuration (before reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);-- Reset the line back to factory default values.;digio.line[3].reset();-- Print configuration (after reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);", - "description": "Output before reset:\n--- --digio.MODE_TRIGGER_OUT 5e-05 trigger.EVENT_DIGIO5\n--- --\u00a0\n--- --Output after reset:\n--- --digio.MODE_TRIGGER_IN 1e-05 trigger.EVENT_NONE\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digout[N].pulsewidth", - "trigger.digout[N].stimulus" - ] - }, - { - "name": "trigger.digin[N].wait()", - "webhelpfile": "31394.htm", - "signature": "trigger.digin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time trigger.digin[N].wait() or trigger.digin[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and is ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detected", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.digin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;triggered = trigger.digin[4].wait(3);print(triggered);", - "description": "Waits up to 3 s for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].release()", - "webhelpfile": "31395.htm", - "signature": "trigger.digout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].assert()", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "trigger.lanout[N].assert()", - "webhelpfile": "31396.htm", - "signature": "trigger.lanout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].assert();", - "description": "Creates a trigger with LAN trigger 5.\n" - } - ], - "related_commands": [ - "lan.lxidomain", - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].wait()", - "webhelpfile": "31397.htm", - "signature": "trigger.lanin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time trigger.lanin[N].wait() or trigger.lanin[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.lanin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.lanin[5].wait(3);", - "description": "Wait for a trigger event with LAN trigger 5 with a timeout of 3\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].clear()", - "webhelpfile": "31398.htm", - "signature": "trigger.lanin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[5].clear();", - "description": "Clears the event detector with LAN event trigger 5.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun" - ] - }, - { - "name": "trigger.lanout[N].connect()", - "webhelpfile": "31401.htm", - "signature": "trigger.lanout[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;trigger.lanout[1].connect();trigger.lanout[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].disconnect()", - "webhelpfile": "31404.htm", - "signature": "trigger.lanout[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger event generator.", - "details": "When this command is set for TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].disconnect()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].connected", - "webhelpfile": "31406.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN event connection state.", - "details": "This is set to true when the LAN trigger is connected and ready to send trigger events after a successful trigger.lanout[N].connect() command. If the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attribute is changed or when the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = trigger.lanout[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;print(trigger.lanout[1].connected);", - "description": "Outputs true if connected, or false if not connected.\n--- --Example output:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].ipaddress", - "webhelpfile": "31409.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted-decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.After you change this setting, you must send the connect command before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = trigger.lanout[N].ipaddress", - "trigger.lanout[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[3].protocol = lan.PROTOCOL_TCP;trigger.lanout[3].ipaddress = \"192.0.32.10\";trigger.lanout[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be TCP when sending LAN triggers.\n--- --Use IP address \"192.0.32.10\" to connect the LAN trigger.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()" - ] - }, - { - "name": "trigger.lanin[N].overrun", - "webhelpfile": "31413.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.lanin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.lanin[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].protocol", - "webhelpfile": "31416.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "lan.PROTOCOL_TCP\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all the supported protocols. However, it uses the designated protocol for sending outgoing messages.After you change this setting, you must re-connect the LAN trigger event generator before you can send outgoing event messages.When multicast is selected, the trigger IP address is ignored, and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.PROTOCOL_TCP nil|lan.PROTOCOL_UDP nil|lan.PROTOCOL_MULTICAST nil", - "type": "triggerlanoutprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = trigger.lanout[N].protocol", - "trigger.lanout[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.lanout[1].protocol);", - "description": "Get LAN protocol that is being used for sending trigger messages for LAN event 1.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "trigger.lanout[N].stimulus", - "webhelpfile": "31419.htm", - "signature": "", - "command_return": "LANevent", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set the event to one of the existing trigger events, which are shown in the following table.Setting this attribute to none disables automatic trigger generation.If any events are detected before the trigger LAN connection is sent, the event is ignored, and the action overrun is set.", - "param_info": [ - { - "name": "LANevent", - "description": "The LAN event that causes this trigger to assert; see Details for values", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "LANevent = trigger.lanout[N].stimulus", - "trigger.lanout[N].stimulus = LANevent" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].stimulus = trigger.EVENT_TIMER1;", - "description": "Use the timer 1 trigger event as the source for LAN trigger 5 stimulus.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "smu.measure.userdelay[N]", - "webhelpfile": "31441.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay (0 for no delay, or 167\u00a0ns to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 for no delay, or 167\u00a0ns to 10 ks)" - }, - { - "name": "N", - "description": "The user delay to which this time applies (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The measurement function; see Functions", - "enum": "", - "type": "smumeasureuserdelayfunction", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.measure.userdelay[N]", - "smu.measure.userdelay[N] = delayTime", - "delayTime = smu.measure.getattribute(function, ATTR_MEAS_USER_DELAY_N)", - "smu.measure.setattribute(function, ATTR_MEAS_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "smu.measure.readwithtime()", - "webhelpfile": "31457.htm", - "signature": "smu.measure.readwithtime()", - "command_return": "reading, seconds, fractional", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates measurements and returns the last actual measurement and time information in UTC format without using the trigger model.", - "details": "This command initiates measurements using the present function setting, stores the readings in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "seconds", - "description": "Seconds in UTC format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractional", - "description": "Fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading, seconds, fractional = smu.measure.readwithtime()", - "smu.measure.readwithtime(bufferName)" - ], - "overloads": [ - "smu.measure.readwithtime(bufferName)" - ], - "examples": [ - { - "example": "print(smu.measure.readwithtime(defbuffer1));", - "description": "Print the last measurement and time information from defbuffer1 in UTC format, which will look similar to:\n--- ---1.405293589829e-11 1400904629 0.1950935\n" - } - ], - "related_commands": [ - "smu.measure.count", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.source.sweeplist()", - "webhelpfile": "31499.htm", - "signature": "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a sweep based on a configuration list, which allows you to customize the sweep.", - "details": "This command allows you to set up a custom sweep, using a configuration list to specify the source levels.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.To run the sweep, initiate the trigger model.You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list where the sweep starts; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is 0 for no delay or you can set a specific delay value from 50 us to 10 ks", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplistcount | integer", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplistfailAbort", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)" - ], - "overloads": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"CurrListSweep\");smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 100e-3;smu.source.level = 1e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 10e-6;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 7e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 11e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 9e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.sweeplist(\"CurrListSweep\", 1, 0.001);smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;trigger.model.initiate();", - "description": "Reset the instrument to its defaults\n--- --Create a source configuration list called CurrListSweep.\n--- --Set the source function to current.\n--- --Set the source current range to 100\u00a0mA.\n--- --Set the source current level to 1\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 10\u00a0uA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 7\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 11\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 9\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set up a list sweep that uses the entries from the CurrListSweep configuration list and starts at index 1 of the list.\n--- --Set a source delay of 1\u00a0ms.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.questionable.setmap()", - "webhelpfile": "31612.htm", - "signature": "status.questionable.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function maps events to bits in the questionable event registers.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.questionable.setmap(bitNumber, setEvent)", - "status.questionable.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.questionable.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.questionable.setmap(0, 4917, 4918);", - "description": "When event 4917 (a default buffer is 0% filled) occurs, bit 0 is set in the condition register and the event register of the Questionable Event Register. When event 4918 (a default buffer is 100% filled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "status.questionable.getmap()" - ] - }, - { - "name": "status.questionable.getmap()", - "webhelpfile": "31613.htm", - "signature": "status.questionable.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Questionable Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - } - ], - "usage": [ - "setEvent, clearEvent = status.questionable.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.getmap(9));", - "description": "Returns the events that were mapped to set and clear bit 9.\n" - } - ], - "related_commands": [ - "Questionable Event Register", - "status.questionable.setmap()" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "31614.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Condition Register of the status model.", - "details": "This command reads the contents of the Questionable Condition Register, which is one of the Questionable Event Registers.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.condition);", - "description": "Reads the Questionable Condition Register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "31615.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the questionable event enable register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Questionable Event Register.When one of these bits is set, when the corresponding bit in the Questionable Event Register or Questionable Condition Register is set, the MSB and QSM bits in the Status Byte Register are set.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.enable", - "status.questionable.enable = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = 17;print(status.questionable.enable);", - "description": "Set bits 0 and 4 of the Questionable Event Enable Register.\n--- --Returns 17, which indicates the register was set correctly.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.condition", - "webhelpfile": "31635.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "You can use this command to read the status byte, which is returned as a numeric value. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence. The returned value can indicate that one or more status events occurred. If more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).The meanings of the individual bits of this register are shown in the following table.", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Example output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "31637.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the Operation Event Enable Register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Operation Event Register.When one of these bits is set, when the corresponding bit in the Operation Event Register or Operation Condition Register is set, the OSB bit in the Status Byte Register is set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.enable", - "status.operation.enable = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Sets the 12 and 14 bits of the operation status enable register using a decimal value.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "31638.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This attribute reads the operation event register of the status model.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.event" - ], - "overloads": [], - "examples": [ - { - "example": "status.request_enable = status.OSB ;status.operation.setmap(0, 4918, 4917);status.operation.enable = 1;defbuffer1.clear();defbuffer1.fillmode = buffer.FILL_ONCE;defbuffer1.capacity = 10;smu.measure.count = 10;smu.measure.read();print(status.operation.event);", - "description": "Set bits in the Status Request Enable Register to record an enabled event in the Operation Status Register.\n--- --Map event number 4918 (a default buffer is full) to set bit 0 in the Operation Event Register and event number 4917 (a default buffer is empty) to clear bit 0.\n--- --Clear defbuffer1.\n--- --Set defbuffer1 to fill once.\n--- --Resizes defbuffer1 to 10 readings. \n--- --Sets the measure count to 10 readings and makes a measurement. \n--- --Reads the operation event register.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "31639.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This command reads the contents of the Operation Condition Register, which is one of the Operation Event Registers.For detail on interpreting the value of a register, see Understanding bit settings.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.condition);", - "description": "Returns the contents of the register.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.setmap()", - "webhelpfile": "31648.htm", - "signature": "status.operation.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to map events to bits in the Operation Event Register.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.operation.setmap(bitNumber, setEvent)", - "status.operation.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.operation.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.operation.setmap(0, 2731, 2732);", - "description": "When event 2731 (trigger model initiated) occurs, bit 0 in the condition and event registers of the Operation Event Register are set. When event 2732 (trigger model idled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "Operation Event Register", - "Programmable status register sets", - "status.operation.getmap()" - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "31653.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the contents of the Standard Event Status Register set of the status model.", - "details": "When this command returns zero (0), no bits are set. You can send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "standardRegister = status.standard.event" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.standard.event);", - "description": "May return the value 129, showing that the Standard Event Status Register contains binary 10000001\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "32386.htm", - "signature": "", - "command_return": "SRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the settings of the Service Request (SRQ) Enable Register.", - "details": "This command sets or clears the individual bits of the Status Request Enable Register.The Status Request Enable Register is cleared when power is cycled or when a parameter value of 0 is sent with this command.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "SRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings (0 to 255)", - "enum": "", - "type": "integer", - "range": "(SRQ)" - } - ], - "usage": [ - "SRQEnableRegister = status.request_enable", - "status.request_enable = SRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register and clear all other bits.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits and clear all other bits of the service request (SRQ) enable register.\n" - }, - { - "example": "status.request_enable = 0;", - "description": "Clear the register.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.gettime()", - "webhelpfile": "32416.htm", - "signature": "localnode.gettime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the instrument date and time.", - "details": "The time is returned in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "print(os.date('%c', gettime()))", - "description": "Example output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "print(os.date('%c', gettime()));", - "description": "Example output:\n--- --Tue Dec 5 03:44:37 2017\n" - } - ], - "related_commands": [ - "localnode.settime()" - ] - }, - { - "name": "tsplink.line[N].mode", - "webhelpfile": "32538.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "tsplink.MODE_DIGITAL_OPEN_DRAIN\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation of a TSP-Link line.", - "details": "This command defines whether or not the line is used as a digital or trigger control line and if it is an input or output.The line mode can be set to the following options:", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode; see Details", - "enum": "", - "type": "tsplinkLineMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.line[N].mode", - "tsplink.line[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;", - "description": "Sets the trigger mode for synchronization line 3 as a trigger open drain line.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkout[N].logic" - ] - }, - { - "name": "trigger.tsplinkin[N].edge", - "webhelpfile": "32539.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates which trigger edge controls the trigger event detector for a trigger line.", - "details": "When the edge is detected, the instrument asserts a TTL-low pulse for the output.The output state of the I/O line is controlled by the trigger logic. The user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger mode", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggertsplinkinedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "detectedEdge = trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[3].edge = trigger.EDGE_RISING;", - "description": "Sets synchronization line 3 to detect rising edge triggers as input.\n" - } - ], - "related_commands": [ - "digio.writeport()", - "tsplink.line[N].mode", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkout[N].logic", - "webhelpfile": "32540.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger output with output logic for a trigger line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggertsplinkoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "logicType = trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].logic = trigger.LOGIC_POSITIVE;", - "description": "Sets the trigger logic for synchronization line 3 to output a positive pulse.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].reset()", - "webhelpfile": "32541.htm", - "signature": "tsplink.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults.", - "details": "The tsplink.line[N].reset() function resets the following attributes to their default values:This also clears trigger.tsplinkin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes to default values.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].overrun", - "trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].stimulus", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].state", - "webhelpfile": "32542.htm", - "signature": "", - "command_return": "lineState", - "type": "Attribute (RW)", - "default_value": "tsplink.STATE_HIGH\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or writes the digital state of a TSP-Link synchronization line.", - "details": "Use tsplink.writeport() to write to all TSP-Link synchronization lines.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "lineState", - "description": "The state of the synchronization line", - "enum": "tsplink.STATE_LOW nil|tsplink.STATE_HIGH nil", - "type": "tsplinklinestatelineState", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "lineState = tsplink.line[N].state", - "tsplink.line[N].state = lineState" - ], - "overloads": [], - "examples": [ - { - "example": "lineState = tsplink.line[3].state;print(lineState);", - "description": "Assume line 3 is set high, and then the state is read.\n--- --Output:\n--- --tsplink.STATE_HIGH\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode", - "tsplink.writeport()" - ] - }, - { - "name": "trigger.tsplinkout[N].assert()", - "webhelpfile": "32549.htm", - "signature": "trigger.tsplinkout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding trigger event.", - "details": "Initiates a trigger event and does not wait for completion. The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].clear()", - "webhelpfile": "32551.htm", - "signature": "trigger.tsplinkin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. When this command is sent, the instrument:", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[2].clear();", - "description": "Clears the trigger event on TSP-Link line 2.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].overrun", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].overrun", - "webhelpfile": "32552.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = trigger.tsplinkin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkin[1].overrun);", - "description": "If an event on line 1 was ignored, displays true; if no additional event occurred, displays false.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.tsplinkout[N].pulsewidth", - "webhelpfile": "32553.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to 0 asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0.0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0.0 to 100 ks)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "trigger.tsplinkout[N].release()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].release()", - "webhelpfile": "32555.htm", - "signature": "trigger.tsplinkout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP-Link trigger line.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].stimulus", - "webhelpfile": "32558.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to trigger.EVENT_NONE.Do not use this attribute when triggering under script control. Use trigger.tsplinkout[N].assert() instead.The event parameters that you can use are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event identifier for the triggering event (see Details)", - "enum": "", - "type": "triggerEvents", - "range": "(see Details)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "event = trigger.tsplinkout[N].stimulus", - "trigger.tsplinkout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkout[3].stimulus);", - "description": "Outputs the event that will start action on TSP-Link trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkin[N].wait()", - "webhelpfile": "32561.htm", - "signature": "trigger.tsplinkin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events are detected since the last time this command or trigger.tsplinkin[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.tsplinkin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;triggered = trigger.tsplinkin[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on TSP-Link line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].clear()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "32565.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node.", - "details": "This attribute returns the node number of the master in a set of instruments connected using TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "localnode.version", - "webhelpfile": "32595.htm", - "signature": "", - "command_return": "version", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware version of the instrument.", - "details": "This attribute indicates the version number of the firmware that is presently running in the instrument.", - "param_info": [ - { - "name": "version", - "description": "Instrument version level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "version = localnode.version" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.version);", - "description": "Outputs the present version level. Example output:\n--- --1.0.0a\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "32597.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the instrument's serial number.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT2, \"Serial #: \" ..localnode.serialno);display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clears the instrument display.\n--- --Places the serial number of this instrument on the bottom line of the USER swipe screen display. Displays the USER swipe screen.\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.version" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "32628.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "The instrument automatically detects the power line frequency when the instrument is powered on. Power line frequency can be 50\u00a0Hz or 60\u00a0Hz.", - "param_info": [ - { - "name": "frequency", - "description": "The detected line frequency", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;print(frequency);", - "description": "Reads the line frequency setting.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "32684.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.runscript(myConnection, \"myTest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled myTest on the TSP-enabled instrument connected with myConnection.\n" - } - ], - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "smu.measure.configlist.size()", - "webhelpfile": "32926.htm", - "signature": "smu.measure.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the size (number of configuration indexes) of a measure configuration list.", - "details": "", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total count of indexes stored in the specified measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.measure.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.size(\"testMeasList\"));", - "description": "Returns the number of configuration indexes in a measure configuration list named testMeasList.\n--- --Example output:\n--- --1\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "localnode.access", - "webhelpfile": "33140.htm", - "signature": "", - "command_return": "accessType", - "type": "Attribute (RW)", - "default_value": "localnode.ACCESS_FULL\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the type of access users have to the instrument through different interfaces.", - "details": "When access is set to full, the instrument accepts commands from any interface with no login or password.When access is set to exclusive, you must log out of one remote interface and log into another one to change interfaces. You do not need a password with this access.Protected access is similar to exclusive access, except that you must enter a password when logging\u00a0in.When the access is set to locked out, a password is required to change interfaces, including the front-panel interface.Under any access type, if a script is running on one remote interface when a command comes in from another remote interface, the command is ignored and the message \"FAILURE: A script is running, use ABORT to stop it\" is generated.", - "param_info": [ - { - "name": "accessType", - "description": "The type of access", - "enum": "localnode.ACCESS_FULL nil|localnode.ACCESS_EXCLUSIVE nil|localnode.ACCESS_PROTECTED nil|localnode.ACCESS_LOCKOUT nil", - "type": "localnodeaccessaccessType", - "range": "" - } - ], - "usage": [ - "accessType = localnode.access", - "localnode.access = accessType" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.access = localnode.ACCESS_LOCKOUT;login admin;logout;", - "description": "Set the instrument access to locked out.\n--- --Log into the interface using the default password.\n--- --Log out of the interface.\n" - } - ], - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "smu.source.autodelay", - "webhelpfile": "33143.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the automatic delay that occurs when the source is turned on.", - "details": "When autodelay is turned on, the actual delay that is set depends on the range.When source autodelay is on, if you set a source delay, the autodelay is turned off.", - "param_info": [ - { - "name": "state", - "description": "Disable the source auto delay", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaystate", - "range": "" - }, - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaysourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautodelayfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.autodelay", - "smu.source.autodelay = state", - "state = smu.source.getattribute(function, ATTR_SRC_DELAY_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_DELAY_AUTO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.autodelay = smu.OFF;", - "description": "Turn off auto delay when current is being sourced.\n" - } - ], - "related_commands": [ - "smu.source.delay" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "33148.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.DISABLE\n", - "tsp_link": "No\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Do not generate prompts", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = localnode.ENABLE;", - "description": "Enable prompting.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "smu.source.configlist.recall()", - "webhelpfile": "33155.htm", - "signature": "smu.source.configlist.recall(listName, index, measureListName, measureIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a specific configuration index in a specific source configuration list and an optional measure configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a specific source configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified source configuration list of that index.You can optionally specify a measure configuration list and index to recall with the source settings. If you do not specify a measure index, the measure index defaults to match the source index. Specify a source and measure list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need have the application of the source and measure configuration lists coordinated, you can specify just the source configuration list with this command and use the smu.measure.configlist.recall() command to recall measure settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, event code 2790, \"Configuration list, error, does not exist\" is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. To see the settings that are recalled with an index, use the smu.source.configlist.query() command.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "measureListName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "measureIndex", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)", - "smu.source.configlist.recall(listName, index, measureListName, measureIndex)" - ], - "overloads": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)" - ], - "examples": [ - { - "example": "smu.source.configlist.recall(\"MySourceList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "trigger.lanout[N].logic", - "webhelpfile": "33157.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line.", - "details": "", - "param_info": [ - { - "name": "logicType", - "description": "The type of logic", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerlanoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "logicType = trigger.lanout[N].logic", - "trigger.lanout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[2].logic = trigger.LOGIC_POSITIVE;", - "description": "Set the logic for LAN trigger line 2 to positive.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digout[N].logic", - "webhelpfile": "33159.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the output logic of the trigger event generator to positive or negative for the specified line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerdigoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "logicType = trigger.digout[N].logic", - "trigger.digout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].logic = trigger.LOGIC_NEGATIVE;", - "description": "Sets line 4 mode to be a trigger output and sets the output logic of the trigger event generator to negative (asserts a low pulse).\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "33164.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This command is not available if the buffer style is set to compact.This read-only attribute is an array of status values for the readings in the buffer. The status values are floating-point numbers that encode the status value. Refer to the following table for values.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired; refer to Details", - "enum": "", - "type": "bufferVarstatuses", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.statuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --64, 64\n--- --Indicating that the status is buffer.STAT_LIMIT1_LOW.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.delete()", - "bufferVar.clear()", - "bufferVar.sourcestatuses", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.save()", - "webhelpfile": "33210.htm", - "signature": "buffer.save(bufferVar, fileName, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves data from the specified reading buffer to a USB flash drive.", - "details": "The filename must specify the full path (including /usb1/). If included, the file extension must be set to .csv (if no file extension is specified, .csv is added).For options that save more than one item of time information, each item is comma-delimited. For example, the default format is date, time, and fractional seconds for each reading.Examples of valid destination file names:The Model 2450 does not check for existing files when you save. Verify that you are using a unique name to avoid overwriting any existing .csv files on the flash drive.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user\u2011defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Defines how date and time information from the buffer is saved in the file on the USB flash drive; the values are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersavetimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, timeFormat)", - "buffer.save(bufferVar, fileName, timeFormat, start, end)" - ], - "overloads": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, timeFormat)" - ], - "examples": [ - { - "example": "buffer.save(MyBuffer, \"/usb1/myData.csv\");", - "description": "Save all reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Save all readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(defbuffer1, \"/usb1/defbuf1data\", buffer.SAVE_RAW_TIME);", - "description": "Save readings and raw time stamps from defbuffer1 to a file named defbuf1data on the USB flash drive.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.saveappend()", - "Reading buffers", - "Remote buffer operation" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "33260.htm", - "signature": "display.prompt(buttonID, promptText)", - "command_return": "promptID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an interactive dialog prompt that displays a custom message on the front-panel display.", - "details": "This command displays buttons and text on the front panel. You can set up scripts that respond to the buttons when they are selected.If you send display.BUTTONS_NONE, the operator needs to press the EXIT key to clear the message from the front-panel display. You can also use the display.delete() command to remove the prompt.Only one prompt can be active at a time.When the user presses a button, the button presses are returned as one of the following options:To capture return values, you need to use display.waitevent() to wait for the user button selection.", - "param_info": [ - { - "name": "promptID", - "description": "A set of characters that identifies the prompt; up to 63 characters", - "enum": "", - "type": "promptID", - "range": "" - }, - { - "name": "buttonID", - "description": "The type of prompt to display; choose one of the following options", - "enum": "display.BUTTONS_NONE nil|display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displaypromptbuttonID", - "range": "" - }, - { - "name": "promptText", - "description": "A string that contains the text that is displayed above the prompts", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "promptID = display.prompt(buttonID, promptText)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.delete()", - "display.waitevent()" - ] - }, - { - "name": "display.waitevent()", - "webhelpfile": "33261.htm", - "signature": "display.waitevent(timeout)", - "command_return": "objectID, subID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to wait for a user to respond to a prompt that was created with a prompt command.", - "details": "This command waits until a user responds to a front-panel prompt that was created with the display.prompt() command.", - "param_info": [ - { - "name": "objectID", - "description": "A number that identifies the object, such as a prompt message, that is displayed on the front panel", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "subID", - "description": "The returned value after a button is pressed on the front panel", - "enum": "display.BUTTON_YES nil|display.BUTTON_NO nil|display.BUTTON_OK nil|display.BUTTON_CANCEL nil", - "type": "displaywaiteventsubID", - "range": "" - }, - { - "name": "timeout", - "description": "The amount of time to wait before timing out; time is 0 to 300 s, where the default of 0 waits indefinitely", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "objectID, subID = display.waitevent()", - "objectID, subID = display.waitevent(timeout)" - ], - "overloads": [ - "objectID, subID = display.waitevent()" - ], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start, and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.input.prompt()", - "display.prompt()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "33286.htm", - "signature": "script.load(file)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The name that is used for scriptVar must not already exist as a global variable. In addition, the scriptVar name must be a global reference and not a local variable, table, or array.For external scripts, the root folder of the USB flash drive has the absolute path /usb1/.", - "param_info": [ - { - "name": "file", - "description": "A string that contains the path and file name of the script file to load; if scriptVar is not defined, this name is used as the global variable name for this script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The created script; a global variable with this name is used to reference the script", - "enum": "", - "type": "scriptVar", - "range": "" - } - ], - "usage": [ - "script.load(file)", - "scriptVar = script.load(file)" - ], - "overloads": [ - "script.load(file)" - ], - "examples": [ - { - "example": "test8 = script.load(\"/usb1/testSetup.tsp\");", - "description": "Loads the script with the file name testSetup.tsp that is on the USB flash drive and names it test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.catalog()", - "webhelpfile": "33290.htm", - "signature": "for name in script.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script returned from script.catalog()", - "enum": "", - "type": "any", - "range": "()" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the return names from the catalog command", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "for name in script.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n--- --print(name) represent the body parameter shown in the Usage.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "33394.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from the run-time memory and nonvolatile memory.", - "details": "When a script is deleted, the global variable referring to this script is also deleted.You must delete an existing script before you can use the name of that script again. Scripts are not automatically overwritten.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory and the global variable named test8.\n" - } - ], - "related_commands": [ - "Deleting a user script using a remote interface", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "33395.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source code of a script.", - "details": "The body of the script is a single string with lines separated by the new line character.", - "param_info": [ - { - "name": "code", - "description": "The body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source" - ], - "overloads": [], - "examples": [ - { - "example": "print(test7.source);", - "description": "Assuming a script named test7 was created on the instrument, this example retrieves the source code.\n--- --Output:\n--- --reset()\n--- --display.settext(display.TEXT1, \"Text on line 1\")\n--- --display.settext(display.TEXT2, \"Text on line 2\")\n" - } - ], - "related_commands": [ - "scriptVar.save()" - ] - }, - { - "name": "display.lightstate", - "webhelpfile": "33459.htm", - "signature": "", - "command_return": "brightness", - "type": "Attribute (RW)", - "default_value": "display.STATE_LCD_50\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the light output level of the front-panel display.", - "details": "This command changes the light output of the front panel when a test requires different instrument illumination levels.The change in illumination is temporary. The normal backlight settings are restored after a power cycle. You can use this to reset a display that is already dimmed by the front-panel Backlight Dimmer.", - "param_info": [ - { - "name": "brightness", - "description": "The brightness of the display", - "enum": "display.STATE_LCD_100 nil|display.STATE_LCD_75 nil|display.STATE_LCD_50 nil|display.STATE_LCD_25 nil|display.STATE_LCD_OFF nil|display.STATE_BLACKOUT nil", - "type": "displaylightstatebrightness", - "range": "" - } - ], - "usage": [ - "brightness = display.lightstate", - "display.lightstate = brightness" - ], - "overloads": [], - "examples": [ - { - "example": "display.lightstate = display.STATE_LCD_50;", - "description": "Set the display brightness to 50%.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.preset()", - "webhelpfile": "33635.htm", - "signature": "status.preset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears the event registers and the enable registers for operation and questionable. It will not clear the Service Request Enable Register (*SRE) to Standard Request Enable Register (*ESE).Preset does not affect the event queue.The Standard Event Status Register is not affected by this command.", - "param_info": [ - { - "name": "status.preset()", - "description": "Resets the instrument status model.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.preset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.preset();", - "description": "Resets the instrument status model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "buffer.delete()", - "webhelpfile": "33981.htm", - "signature": "buffer.delete(bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a user-defined reading buffer.", - "details": "You cannot delete the default reading buffers, defbuffer1 and defbuffer2.After deleting the buffer, call collectgarbage() to reclaim the memory the buffer was using.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of a user-defined reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "buffer.delete(bufferName)" - ], - "overloads": [], - "examples": [ - { - "example": "buf400\u00a0= buffer.make(400);smu.measure.read(buf400);printbuffer(1, buf400.n, buf400.relativetimestamps);buffer.delete(buf400);collectgarbage();", - "description": "Create a 400-element reading buffer named buf400.\n--- --Make measurements and store the readings in buf400.\n--- --Print the relative timestamps for each reading in the buffer.\n--- --Example output, assuming five readings are stored in the buffer:\n--- --0, 0.412850017, 0.821640085, 1.230558058, 1.629523236\n--- --Delete buf400.\n--- --Use collectgarbage() to unallocate the buffer.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "printbuffer()" - ] - }, - { - "name": "trigger.timer[N].start.seconds", - "webhelpfile": "33984.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.seconds", - "trigger.timer[N].start.seconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.seconds = localnode.gettime() + 30;trigger.timer[1].enable = trigger.ON;", - "description": "Set the trigger timer to start 30 s from the time when the timer is enabled.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].start.fractionalseconds", - "webhelpfile": "33985.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the fractional seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time in fractional seconds (0 to <1 s)", - "enum": "", - "type": "number", - "range": "(0 to <1 s)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.fractionalseconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.fractionalseconds = 0.4;", - "description": "Set the trigger timer to start in 0.4\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].start.generate" - ] - }, - { - "name": "reset()", - "webhelpfile": "34054.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings and clears the buffers.", - "details": "The reset() command in its simplest form resets the entire TSP-enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use the node[N].reset() command. Also use the node[N].reset() command to reset an instrument on a subordinate node.When no value is specified for system, the default value is true.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error event.", - "param_info": [ - { - "name": "system", - "description": "If the node is the master, the entire system is reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error event is generated.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.sourcestatuses", - "webhelpfile": "34340.htm", - "signature": "bufferVar.sourcestatuses[N]", - "command_return": "statusInfo", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source status conditions of the instrument for the reading point.", - "details": "This buffer recall attribute holds an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value for each measurement made. See the following table for values.", - "param_info": [ - { - "name": "statusInfo", - "description": "The status value when reading N of the specified buffer was acquired; Source status values are", - "enum": "buffer.STAT_PROTECTION nil|buffer.STAT_READBACK nil|buffer.STAT_OVER_TEMP nil|buffer.STAT_LIMIT nil|buffer.STAT_SENSE nil|buffer.STAT_OUTPUT nil", - "type": "bufferVarsourcestatusesstatusInfo", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInfo = bufferVar.sourcestatuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.sourcestatuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --136, 136\n--- --Indicating that the status is buffer.STAT_READBACK and buffer.STAT_OUTPUT.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "buffer.delete()", - "print()", - "printbuffer()" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "34363.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP-enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "The termination type", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtermSequence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "34428.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event.Use none to disable the blender input.The event parameter may be any of the trigger events shown in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "triggerEvents[]", - "range": "" - }, - { - "name": "N", - "description": "An integer that represents the trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "buffer.clearstats()", - "webhelpfile": "34560.htm", - "signature": "buffer.clearstats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the statistical information associated with the specified buffer.", - "details": "This command clears the statistics without clearing the readings.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1 if not specified", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "buffer.clearstats()", - "buffer.clearstats(bufferVar)" - ], - "overloads": [ - "buffer.clearstats()" - ], - "examples": [ - { - "example": "buffer.clearstats();", - "description": "Clears statistics for defbuffer1.\n" - } - ], - "related_commands": [ - "buffer.getstats()" - ] - }, - { - "name": "createconfigscript()", - "webhelpfile": "34589.htm", - "signature": "createconfigscript(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a setup file that captures most of the present settings of the instrument.", - "details": "This function does not automatically overwrite existing scripts with the same name. If scriptName is set to the name of an existing script, an event message is returned. You must delete the existing script before using the same script name. This includes the autoexec script, which runs automatically when the instrument power is turned on. You can set scriptName to autoexec, but you must delete the existing autoexec script first using the script.delete(\"autoexec\") command.Once created, the script that contains the settings can be run and edited like any other script.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script that will be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "createconfigscript(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "createconfigscript(\"myConfigurationScript\");reset();myConfigurationScript();", - "description": "Capture the present settings of the instrument into a script named myConfigurationScript.\n--- --Reset the instrument.\n--- --Restore the settings stored in myConfigurationScript.\n" - } - ], - "related_commands": [ - "Saving setups", - "script.delete()" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "34629.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"admin\"\n", - "tsp_link": "No\n", - "description": "This attribute stores the instrument password.", - "details": "When the access to the instrument is set to protected or lockout, this is the password that is used to gain access.If you forget the password, you can reset the password to the default:You can also reset the password and the LAN settings from the rear panel by inserting a straightened paper clip into hole below LAN RESET.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the instrument password (maximum 30 characters)", - "enum": "", - "type": "string", - "range": "(maximum 30 characters)" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the password to N3wpa55w0rd.\n" - } - ], - "related_commands": [ - "localnode.access" - ] - }, - { - "name": "eventlog.post()", - "webhelpfile": "34730.htm", - "signature": "eventlog.post(message, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to post your own text to the event log.", - "details": "You can use this command to create your own event log entries and assign a severity level to them. This can be useful for debugging and status reporting.From the front panel, you must set the Log Warnings and Log Information options on to have the custom warning and information events placed into the event log.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "message", - "description": "String that contains the message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "The type of event; if no event is defined, defaults to eventlog.SEV_INFO", - "enum": "eventlog.SEV_INFO nil|eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil", - "type": "eventlogposteventType", - "range": "" - } - ], - "usage": [ - "eventlog.post(message)", - "eventlog.post(message, eventType)" - ], - "overloads": [ - "eventlog.post(message)" - ], - "examples": [ - { - "example": "eventlog.clear();eventlog.post(\"Results in \\018\", eventlog.SEV_ERROR);print(eventlog.next());", - "description": "Posts an event that states \"Results in \u03a9\".\n--- --Output:\n--- --1005 User: Results in \u03a9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.usbdriveexists()", - "webhelpfile": "34905.htm", - "signature": "file.usbdriveexists()", - "command_return": "driveInserted", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function detects if a USB flash drive is inserted into the front-panel USB port.", - "details": "You can call this command from a script to verify that a USB flash drive is inserted before attempting to write data to it.", - "param_info": [ - { - "name": "driveInserted", - "description": "0", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "driveInserted = file.usbdriveexists()" - ], - "overloads": [], - "examples": [ - { - "example": "local response;local xMax = 10;\u00a0;for x = 1, xMax do; -- Make xMax readings and store them in defbuffer1.; smu.measure.read();end;\u00a0;if (file.usbdriveexists() == 1) then ; response = display.BUTTON_YES;else; response = display.input.prompt(display.BUTTONS_YESNO, \"Insert a USB flash drive.\\nPress Yes to write data or No to not write data.\") ;end;\u00a0;if (response == display.BUTTON_YES) then; if (file.usbdriveexists() == 1) then ; FileNumber = file.open(\"/usb1/TenReadings.csv\", file.MODE_WRITE); file.write(FileNumber,\"Reading,Seconds\\n\");\u00a0; -- Print out the measured values in a two-column format.; print(\"\\nIteration:\\tReading:\\tTime:\\n\");\u00a0; for i = 1, xMax do; print(i, defbuffer1[i], defbuffer1.relativetimestamps[i]); file.write(FileNumber, string.format(\"%g, %g\\r\\n\",defbuffer1.readings[i], defbuffer1.relativetimestamps[i])); end; file.close(FileNumber); else; response = display.input.prompt(display.BUTTONS_OK,; \"No drive detected. Allow more time after inserting a drive.\") ; end;end;", - "description": "Make measurements.\n--- --Verify that a flash drive is inserted into the instrument.\n--- --If the flash drive is inserted, write the data to the flash drive.\n--- --Print data into a two-column format.\n--- --If the flash drive is not inserted after selecting Yes, another prompt is displayed.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.userdelay[N]", - "webhelpfile": "34973.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay in seconds (0 to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 to 10 ks)" - }, - { - "name": "N", - "description": "The number that identifies this user delay (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.source.userdelay[N]", - "smu.source.userdelay[N] = delayTime", - "delayTime = smu.source.getattribute(function, ATTR_SRC_USER_DELAY_N)", - "smu.source.setattribute(function, ATTR_SRC_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_S1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for source 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls source user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "35118.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to two) on which to wait", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n--- --Wait 3 s while checking if trigger blender 1 event has occurred.\n" - } - ], - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.model.load() - ConfigList", - "webhelpfile": "35126.htm", - "signature": "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that uses source and measure configuration lists.", - "details": "This trigger-model template incorporates a source configuration list and measure configuration list. You must set up the configuration lists before loading the trigger model. If the configuration lists change, you must resend this command.You can also set a delay and change the reading buffer.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "ConfigList", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "measureConfigList", - "description": "A string that contains the name of the measurement configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceConfigList", - "description": "A string that contains the name of the source configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"SOURCE_LIST\");smu.measure.configlist.create(\"MEASURE_LIST\");smu.source.level = 1;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 1e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 5;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 10e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 10;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 100e-3;smu.measure.configlist.store(\"MEASURE_LIST\");trigger.model.load(\"ConfigList\", \"MEASURE_LIST\", \"SOURCE_LIST\");trigger.model.initiate();", - "description": "Set up a source configuration list named SOURCE_LIST and a measurement configuration list named MEASURE_LIST. Load the configuration list trigger model, using these two configuration lists. Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - Empty", - "webhelpfile": "35127.htm", - "signature": "trigger.model.load(Empty)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger model.", - "details": "When you load this trigger-model template, any blocks that have been defined in the trigger model are cleared so the trigger model has no blocks defined.", - "param_info": [ - { - "name": "Empty", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "trigger.model.load(\"Empty\")print(trigger.model.getblocklist())", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Clear the trigger model to have no blocks defined.Output:EMPTY", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.load(Empty)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model to have no blocks defined.\n--- --Output:\n--- --EMPTY\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LogicTrigger", - "webhelpfile": "35128.htm", - "signature": "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a logic trigger through the digital I/O.", - "details": "This trigger model waits for a digital input event to occur, makes a measurement, and issues a notify event. The notify event asserts a digital output line.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.This command replaces the trigger.model.load() \u2014 ExternalTrigger command, which is deprecated. Note that the clear parameter is not available for ExternalTrigger.", - "param_info": [ - { - "name": "LogicTrigger", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "digInLine", - "description": "The digital input line (1 to 6); also, the event that the trigger model will wait on in block\u00a01", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "digOutLine", - "description": "The digital output line (1 to 6)", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLogicTriggerclear", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)" - ], - "examples": [ - { - "example": "trigger.model.load(\"LogicTrigger\", 1, 2, 10, 0.001, defbuffer1);", - "description": "Set up the template to use the digital in line and wait for a pulse from digital in line 1 to trigger measurements.\n--- --Pulse digital out line 2 when the measurement is complete.\n--- --Make 10 measurements, with a delay of 1\u00a0ms before each measurement.\n--- --Store the measurements in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.digout[N].logic" - ] - }, - { - "name": "trigger.model.load() \u2014 Simple Loop", - "webhelpfile": "35129.htm", - "signature": "trigger.model.load(SimpleLoop, count, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a predefined trigger model configuration that does a specified number of measurements.", - "details": "This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the count parameter.", - "param_info": [], - "usage": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)", - "trigger.model.load(SimpleLoop, count, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)" - ], - "examples": [ - { - "example": "reset(); ;--set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;--set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;--turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;--Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;--Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses the Simple Loop trigger model template to do a capacitor test. This example produces 200 readings that have output similar to the following example:\n--- --Rdg #\tTime (s)\tCurrent (A)\n--- --1\t0 8.5718931952528e-11\n--- --2\t0.151875 1.6215984111057e-10\n--- --3\t0.303727 1.5521139928865e-10\n--- --. . .\n--- --198\t29.91579194\t1.5521250951167e-10\n--- --199\t30.067648716\t1.4131290582142e-10\n--- --200\t30.219497716\t1.5521067764368e-10\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_LOG_EVENT", - "webhelpfile": "35428.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to log an event in the event log when the trigger model is running.", - "details": "Note that using this block too often in a trigger model could overflow the event log. It may also take away from the time needed to process more critical trigger model blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "eventNumber", - "description": "The event number", - "enum": "trigger.LOG_INFO nil|trigger.LOG_WARN nil|trigger.LOG_ERROR nil|trigger.LOG_WARN_ABORT nil", - "type": "triggermodelsetblocktriggerBLOCK_LOG_EVENTeventNumber", - "range": "" - }, - { - "name": "message", - "description": "A string up to 31 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_LOG_EVENT, trigger.LOG_INFO2, \"Trigger model complete.\");", - "description": "Set trigger model block 9 to log an event when the trigger model completes. In the event log, the message is:\n--- --TM #1 block #9 logged: Trigger model complete.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_NOP", - "webhelpfile": "35431.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a placeholder that performs no action in the trigger model; available only using remote commands.", - "details": "If you remove a trigger model block, you can use this block as a placeholder for the block number so that you do not need to renumber the other blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_NOP);", - "description": "Set block number 4 to be a no operation block.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.delete()", - "webhelpfile": "38977.htm", - "signature": "display.delete(promptID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to remove a prompt on the front-panel display that was created with display.prompt().", - "details": "You can use this command to remove the presently displayed prompt.", - "param_info": [ - { - "name": "promptID", - "description": "The identifier defined by display.prompt()", - "enum": "", - "type": "promptID", - "range": "()" - } - ], - "usage": [ - "display.delete(promptID)" - ], - "overloads": [], - "examples": [ - { - "example": "removePrompt3 = display.prompt(display.BUTTONS_NONE, \"This prompt will disappear in 3 seconds\");delay(3);display.delete(removePrompt3);", - "description": "This example displays a prompt that is automatically removed in three seconds.\n--- --\n" - } - ], - "related_commands": [ - "display.prompt()" - ] - }, - { - "name": "eventlog.suppress()", - "webhelpfile": "40049.htm", - "signature": "eventlog.suppress(eventNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This command allows you to suppress system events from generating a popup on the front\u2011panel interface.", - "details": "The eventType parameter allows you to suppress groups of events (errors, warnings, and information). You can combine the event types to suppress more than one type. For example, to suppress information and error events, send the command:You can use the eventNumber parameter to suppress individual system events.This command does not prevent system events from appearing in the event log or in a file on a USB flash drive if the event log is saved.An event number is the number that accompanies an error, warning, or information message that is reported in the event log. For example, for the error \"Error -109, Missing parameter,\" the event number is -109. Note that some messages that are displayed on the front panel are not recorded in the event log. Only messages that include an event number can be suppressed.", - "param_info": [ - { - "name": "eventType", - "description": "The type of the event to be suppressed", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsuppresseventType", - "range": "" - }, - { - "name": "eventNumber", - "description": "The number of a specific event to be suppressed", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "eventlog.suppress(eventType)", - "eventlog.suppress(eventNumber)" - ], - "overloads": [ - "eventlog.suppress(eventType)" - ], - "examples": [ - { - "example": "eventlog.suppress(-109);", - "description": "Suppress -109, the missing parameter message, from displaying a popup on the front panel.\n" - } - ], - "related_commands": [ - "eventlog.save()" - ] - }, - { - "name": "display.input.number()", - "webhelpfile": "40051.htm", - "signature": "display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)", - "command_return": "numberEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that requests a number from the user on the front-panel display.", - "details": "This command prompts the instrument operator to enter a value.The prompt is displayed until it has been responded to.", - "param_info": [ - { - "name": "numberEntered", - "description": "The number that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; can be up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "numberFormat", - "description": "The format of the displayed number", - "enum": "display.NFORMAT_INTEGER nil|display.NFORMAT_DECIMAL nil|display.NFORMAT_EXPONENT nil|display.NFORMAT_PREFIX nil", - "type": "displayinputnumbernumberFormat", - "range": "" - }, - { - "name": "defaultValue", - "description": "The value that is initially displayed in the displayed keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimumValue", - "description": "The lowest value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximumValue", - "description": "The highest value that can be entered", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)" - ], - "overloads": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)" - ], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;testcurrent = display.input.number(\"Enter a Test Current (0 to 1 A)\", display.NFORMAT_PREFIX, 0, 0, 1);smu.source.level = testcurrent;", - "description": "This example displays a number pad on the screen that defaults to 0 and allows entries from 0 to 1. The number that the operator enters is assigned to the source current level. If the operator enters a value outside of the range, an error message is displayed.\n--- --\n" - } - ], - "related_commands": [ - "display.input.option()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.option()", - "webhelpfile": "40052.htm", - "signature": "display.input.option(dialogTitle, buttonTitle1, ...)", - "command_return": "BUTTON_OPTIONn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an option dialog box with customizable buttons on the front-panel display.", - "details": "Buttons are created from top to bottom, left to right. If you have more than five buttons, they are placed into two columns.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "n", - "description": "The number of the button that is selected from the front-panel display; nil if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right", - "enum": "", - "type": "display_BUTTON_OPTIONs | nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "buttonTitle1", - "description": "A string that contains the name of the first button; up to 15 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "A string that contains the names of subsequent buttons, where N is a number from 2 to 10; you can define up to 10 buttons; each button can be up to 15 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "BUTTON_OPTIONn = display.input.option(dialogTitle, buttonTitle1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "optionID = display.input.option(\"Select an option\", \"Apple\", \"Orange\", \"Papaya\", \"Pineapple\", \"Blueberry\", \"Banana\", \"Grapes\", \"Peach\", \"Apricot\", \"Guava\");print(optionID);", - "description": "This example displays the following dialog box:\n--- --\n--- --If the user selects Peach, the return is display.BUTTON_OPTION8.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.prompt()", - "webhelpfile": "40053.htm", - "signature": "display.input.prompt(buttonSet, dialogTitle)", - "command_return": "buttonReturn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that accepts a user response from the front-panel display.", - "details": "This command waits for a user response to the prompt. You can use the text to ask questions that can be used to configure your test.The prompt is displayed until it has been responded to by the user. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "buttonReturn", - "description": "Indicates which button was pressed", - "enum": "display.BUTTON_OK nil|display.BUTTON_CANCEL nil|display.BUTTON_YES nil|display.BUTTON_NO nil", - "type": "displayinputpromptbuttonReturn", - "range": "" - }, - { - "name": "buttonSet", - "description": "The set of buttons to display", - "enum": "display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displayinputpromptbuttonSet", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 63 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buttonReturn = display.input.prompt(buttonSet, dialogTitle)" - ], - "overloads": [], - "examples": [ - { - "example": "result = display.input.prompt(display.BUTTONS_YESNO, \"Do you want to display the graph screen?\");if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "This displays the prompt \"Do you want to display the graph screen?\" on the front-panel display:\n--- --\n--- -- If the operator selects Yes, the graph screen is displayed.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.string()" - ] - }, - { - "name": "display.input.string()", - "webhelpfile": "40054.htm", - "signature": "display.input.string(dialogTitle, textFormat)", - "command_return": "textEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a dialog box that requests text from the user through the front-panel display.", - "details": "This command creates a prompt to the instrument operator to enter a string value.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "textEntered", - "description": "The text that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "textFormat", - "description": "The format of the entered text", - "enum": "display.SFORMAT_ANY nil|display.SFORMAT_UPPER_LOWER nil|display.SFORMAT_UPPER nil|display.SFORMAT_BUFFER_NAME nil", - "type": "displayinputstringtextFormat", - "range": "" - } - ], - "usage": [ - "textEntered = display.input.string(dialogTitle)", - "textEntered = display.input.string(dialogTitle, textFormat)" - ], - "overloads": [ - "textEntered = display.input.string(dialogTitle)" - ], - "examples": [ - { - "example": "value = display.input.string(\"Enter Test Name\", display.SFORMAT_ANY);print(value);", - "description": "This example displays the prompt \"Enter Test Name\" and a keyboard that the operator can use to enter a response.\n--- --\n--- --The return is the response from the operator.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.prompt()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "40235.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.ENABLE\n", - "tsp_link": "No\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = localnode.DISABLE;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "smu.measure.limit[Y].audible", - "webhelpfile": "41684.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.AUDIBLE_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument beeper sounds when a limit test passes or fails.", - "details": "The tone and length of beeper cannot be adjusted.See smu.measure.limit[Y].fail for an example of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "When the beeper sounds", - "enum": "smu.AUDIBLE_NONE nil|smu.AUDIBLE_FAIL nil|smu.AUDIBLE_PASS nil", - "type": "smumeasurelimitaudiblestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitaudiblefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].audible", - "smu.measure.limit[Y].audible = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "state;", - "description": "When the beeper sounds:\n--- --Never: smu.AUDIBLE_NONEOn test failure: smu.AUDIBLE_FAILOn test pass: smu.AUDIBL" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": " trigger.BLOCK_RESET_BRANCH_COUNT", - "webhelpfile": "41689.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a block in the trigger model that resets a branch counter to 0.", - "details": "When the trigger model reaches the Counter Reset block, it resets the count of the specified Branch on Counter block to zero.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "counter", - "description": "The block number of the counter that is to be reset", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 5, 2);trigger.model.setblock(4, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 3, 2);trigger.model.setblock(6, trigger.BLOCK_RESET_BRANCH_COUNT, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and take 5 readings.\n--- --Delay a second.\n--- --Loop three more times back to block 2.\n--- --Reset block 3 to 0.\n--- --Start the trigger model and wait for measurements to complete.\n--- --Print the number of readings in the buffer.\n--- --Output:\n--- --15\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.load() - SimpleLoop", - "webhelpfile": "46034.htm", - "signature": "trigger.model.load(SimpleLoop, count, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes a specific number of measurements.", - "details": "This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the Count parameter.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger-model blocks in a list format.", - "param_info": [ - { - "name": "SimpleLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)", - "trigger.model.load(SimpleLoop, count, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses the SimpleLoop trigger-model template to do a capacitor test. This example produces 200 readings that have output similar to the following example:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LoopUntilEvent", - "webhelpfile": "46040.htm", - "signature": "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements until the specified event occurs.", - "details": "The event constant is the event that ends infinite triggering or ends readings set to occur before the trigger and start post-trigger readings. The trigger model makes readings until it detects the event constant. After the event, it makes a finite number of readings, based on the setting of the trigger position.The position marks the location in the reading buffer where the trigger will occur. The position is set as a percentage of the buffer capacity. The buffer captures measurements until a trigger occurs. When the trigger occurs, the buffer retains the percentage of readings specified by the position, then captures remaining readings until 100\u00a0percent of the buffer is filled. For example, if this is set to 75 for a reading buffer that holds 10,000 readings, the trigger model makes 2500 readings after it detects the source event. There are 7500 pre-trigger readings and 2500 post-trigger readings.The instrument makes two sets of readings. The first set is made until the trigger event occurs. The second set is made after the trigger event occurs, up to the number of readings calculated by the position parameter.You cannot have the event constant set at none when you run this trigger-model template.The following table lists the options that are available for triggerEvent.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "LoopUntilEvent", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "triggerEvent", - "description": "The event that ends infinite triggering or readings set to occur before the trigger; see Details", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "position", - "description": "The number of readings to make in relation to the size of the reading buffer; enter as a percentage (0% to 100%)", - "enum": "", - "type": "number", - "range": "(0% to 100%)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block (default)", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLoopUntilEventclear", - "range": "(default)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Initiate readings;trigger.model.load(\"LoopUntilEvent\", trigger.EVENT_DISPLAY, 50);trigger.model.initiate();", - "description": "Reset the instrument.\n--- --Set the instrument to measure current.\n--- --Load the LoopUntilEvent trigger model to make measurements until the front panel trigger key is pressed, then continue to make measurements equal to 50% of the reading buffer size.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - GradeBinning", - "webhelpfile": "46058.htm", - "signature": "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a grading operation.", - "details": "This trigger-model template allows you to grade components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the pass pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "GradeBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 1; range 1 to 15; default is\u00a01", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 2; range 1 to 15; default is\u00a02", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 3; range 1 to 15; default is\u00a04", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 4; range 1 to 15; default is\u00a08", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have passed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - SortBinning", - "webhelpfile": "46066.htm", - "signature": "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a sorting operation.", - "details": "This trigger-model template allows you to sort components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the all fail pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "SortBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 1; range 1 to 15; default is 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 2; range 1 to 15; default is 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 3; range 1 to 15; default is 4", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 4; range 1 to 15; default is 8", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have failed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.extravalues", - "webhelpfile": "46323.htm", - "signature": "bufferVar.extravalues[N]", - "command_return": "extraValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the additional values in a reading buffer.", - "details": "This attribute contains an additional value, such as the extra value written to a writable buffer. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extravalue", - "description": "The extra values for readings", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraValue = bufferVar.extravalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.write.format()", - "webhelpfile": "46427.htm", - "signature": "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the units and number of digits of the readings that are written into the reading buffer.", - "details": "This command is valid when the buffer style is writable or full writable. When the buffer style is set to full writable, you can include an extra value.The format defines the units and the number of digits that are reported for the data. This command affects how the data is shown in the reading buffer and what is shown on the front-panel Home, Histogram, Reading Table, and Graph screens.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "units", - "description": "The units for the first measurement in the buffer index", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "bufferwriteformatunits", - "range": "" - }, - { - "name": "displayDigits", - "description": "The number of digits to use for the first measurement", - "enum": "buffer.DIGITS_3_5 nil|buffer.DIGITS_4_5 nil|buffer.DIGITS_5_5 nil|buffer.DIGITS_6_5 nil|buffer.DIGITS_7_5 nil|buffer.DIGITS_8_5 nil", - "type": "bufferwriteformatdisplayDigits", - "range": "" - }, - { - "name": "extraUnits", - "description": "The units for the second measurement in the buffer index; the selections are the same as units (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for units", - "enum": "", - "type": "bufferwriteformatunits", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "extraDigits", - "description": "The number of digits to use for the second measurement; the selections are the same as displayDigits (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for displayDigits", - "enum": "", - "type": "bufferwriteformatdisplayDigits", - "range": "(only valid for buffer style WRITABLE_FULL)" - } - ], - "usage": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)" - ], - "overloads": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1.0000000000e+00, Watt DC, 2.0000000000e+00, Watt DC, 3.0000000000e+00, Watt DC, 4.0000000000e+00, Watt DC, 5.0000000000e+00, Watt DC, 6.0000000000e+00, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.reading()" - ] - }, - { - "name": "buffer.write.reading()", - "webhelpfile": "46428.htm", - "signature": "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to write readings into the reading buffer.", - "details": "For buffers that are set to the writable buffer style:For buffers that are set to the full writable buffer style:This command writes the data you specify into a reading buffer. The reading buffer must be set to the writable or full writable style, which is set when you make the buffer.Data must be added in chronological order. If the time is not specified for a reading, it is set to one integer second after the last reading. As you write the data, the front-panel home screen updates and displays the reading you entered.The status parameter provides additional information about the reading. The options are shown in the following table.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "readingValue", - "description": "The first value that is recorded in the buffer index", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "extraValue", - "description": "A second value that is recorded in the buffer index (only valid for buffer style WRITABLE_FULL)", - "enum": "", - "type": "integer", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "seconds", - "description": "An integer that represents the seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractionalSeconds", - "description": "The portion of the time that represents the fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "status", - "description": "Additional information about the reading; see Details", - "enum": "", - "type": "readingStatus", - "range": "" - } - ], - "usage": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)" - ], - "overloads": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.startindex", - "webhelpfile": "56793.htm", - "signature": "bufferVar.startindex", - "command_return": "startIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the starting index in a reading buffer.", - "details": "Use this attribute to find the starting index in a reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Starting index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.startindex = startIndex " - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n" - } - ], - "related_commands": [ - "bufferVar.endindex", - "buffer.make()" - ] - }, - { - "name": "bufferVar.endindex", - "webhelpfile": "56794.htm", - "signature": "bufferVar.endindex", - "command_return": "endIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the last index in a reading buffer.", - "details": "Use this attribute to find the ending index in a reading buffer.", - "param_info": [ - { - "name": "endIndex", - "description": "Ending index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.endindex = endIndex" - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);smu.measure.read(test1);print(test1.startindex, test1.endindex);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n--- --Make six more measurements and store them in buffer test1.\n--- --Get the start index and end index of test1.\n--- --Output:\n--- --1, 12\n" - } - ], - "related_commands": [ - "bufferVar.startindex", - "buffer.make()" - ] - }, - { - "name": "trigger.model.pause()", - "webhelpfile": "72471.htm", - "signature": "trigger.model.pause()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function pauses a running trigger model.", - "details": "This command pauses the trigger model.To continue the trigger model, send the resume command.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.pause()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.resume()" - ] - }, - { - "name": "trigger.model.resume()", - "webhelpfile": "73512.htm", - "signature": "trigger.model.resume()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function continues a paused trigger model.", - "details": "This command continues running the trigger model operation if the trigger model was paused.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.resume()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.pause()" - ] - }, - { - "name": "buffer.math()", - "webhelpfile": "73595.htm", - "signature": "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to run a mathematical expression on a measurement. The expression is applied when the measurement is placed in the reading buffer.", - "details": "", - "param_info": [ - { - "name": "readingBuffer", - "description": "The name of the reading buffer; the reading buffer selected must be set to the style FULL", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "unit", - "description": "The units to be applied to the value generated by the expression", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "buffermathunit", - "range": "" - }, - { - "name": "constant0", - "description": "The constant to be used for c0 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant1", - "description": "The constant to be used for c1 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant2", - "description": "The constant to be used for c2 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant3", - "description": "The constant to be used for c3 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant4", - "description": "The constant to be used for c4 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant5", - "description": "The constant to be used for c5 in the expression", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)" - ], - "overloads": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)" - ], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;\u00a0;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);\u00a0;print(\"Extra value reading 1: \", mathExp.extravalues[1]);print(\"Extra value reading 2: \", mathExp.extravalues[2]);print(\"Extra value reading 3: \", mathExp.extravalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: 6.3863430578e-05\n--- --Reading: 6.7818055872e-05\n--- --Reading: 1.9871571784e-05\n--- --Extra value reading 1: 6.3863430578e-05\n--- --Extra value reading 2: 4.3310937031e-09\n--- --Extra value reading 3: 1.3476513655e-09\n" - } - ], - "related_commands": [ - "buffer.unit()" - ] - }, - { - "name": "buffer.unit()", - "webhelpfile": "76401.htm", - "signature": "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create up to three custom units of measure for use in buffers.", - "details": "You can use custom units of measures in buffer math and writable buffers.If you specify more than two characters, the additional characters are ignored. Some characters are converted to other symbols:This unit is reset when power is cycled. It is not affected by reset.", - "param_info": [ - { - "name": "UNIT_CUSTOMN", - "description": "Custom unit user can create, The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "bufferCustomUnit", - "range": "" - }, - { - "name": "N", - "description": "The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "unitOfMeasure", - "description": "A string that defines the custom unit; up to three characters; defaults are X for custom unit 1, Y for unit 2, and Z for unit 3", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.unit(buffer.UNIT_CUSTOM1, \"fb\") ;\u00a0;buffer.math(mathExp, buffer.UNIT_CUSTOM1, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading \"..x..\":\", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);for x = 1, 3 do ; print(\"Extra value reading \"..x..\":\", mathExp.extravalues[x]);end;", - "description": "Instrument has terminals set to FRONT.\n--- --Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the customer 1 buffer unit to fb.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make 3 readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading 1: 0.00015611271869\n--- --Reading 2: 9.0539004907e-05\n--- --Reading 3: 0.30001141669554\n--- --Extra value reading 1: 0.00015611271869\n--- --Extra value reading 2: 1.4134290203e-08\n--- --Extra value reading 3: 1.0336562635e-08\n" - } - ], - "related_commands": [ - "buffer.math()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.extraformattedvalues", - "webhelpfile": "81089.htm", - "signature": "bufferVar.extraformattedvalues[N]", - "command_return": "extraFormat", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement and the unit of measure of the additional values in a reading buffer.", - "details": "This attribute contains the measurement and the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraFormat", - "description": "The measurement and unit of measure of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraFormat = bufferVar.extraformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(400, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;display.changescreen(display.SCREEN_READING_TABLE);print(\"Extra value reading 1: \", mathExp.extraformattedvalues[1]);print(\"Extra value reading 2: \", mathExp.extraformattedvalues[2]);print(\"Extra value reading 3: \", mathExp.extraformattedvalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 400 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: \t7.1233589551e-06\n--- --Reading: \t7.1233080234e-06\n--- --Reading: \t7.2616603575e-06\n--- --Extra value reading 1: \t+7.1233590 u\n--- --Extra value reading 2: \t+50.741880 p\n--- --Extra value reading 3: \t+51.727043 p\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.extravalueunits", - "webhelpfile": "81090.htm", - "signature": "bufferVar.extravalueunits[N]", - "command_return": "extraUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of the additional values in a reading buffer.", - "details": "This attribute contains the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraUnits", - "description": "The units of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraUnits = bufferVar.extravalueunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.extravalueunits);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and extra value units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.activebuffer", - "webhelpfile": "81840.htm", - "signature": "", - "command_return": "bufferName", - "type": "Attribute (RW)", - "default_value": "defbuffer1\n", - "tsp_link": "Yes\n", - "description": "This attribute determines which buffer is used for measurements that are displayed on the front panel.", - "details": "The buffer defined by this command is used to store measurements data and is shown in the reading buffer indicator on the home screen of the instrument.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of the buffer to make active", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferName = display.activebuffer", - "display.activebuffer = bufferName" - ], - "overloads": [], - "examples": [ - { - "example": "display.activebuffer = buffer2;", - "description": "Set the front panel to use buffer2 as the active reading buffer.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "buffer.save()", - "webhelpfile": "85101.htm", - "signature": "buffer.save(bufferVar, fileName, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves data from the specified reading buffer to a USB flash drive.", - "details": "The file name must specify the full path (including /usb1/). If included, the file extension must be set to .csv. If no file extension is specified, .csv is added.Examples of valid destination file names:The Model 2450 does not check for existing files when you save. Verify that you are using a unique name to avoid overwriting any existing CSV files on the flash drive.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Defines how date and time information from the buffer is saved in the file on the USB flash drive; the options are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersavetimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, timeFormat)", - "buffer.save(bufferVar, fileName, timeFormat, start, end)" - ], - "overloads": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, timeFormat)" - ], - "examples": [ - { - "example": "buffer.save(MyBuffer, \"/usb1/myData.csv\");", - "description": "Save all reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Save all readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(defbuffer1, \"/usb1/defbuf1data\", buffer.SAVE_RAW_TIME);", - "description": "Save readings and raw time stamps from defbuffer1 to a file named defbuf1data on the USB flash\u00a0drive.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.saveappend()" - ] - }, - { - "name": "trigger.continuous", - "webhelpfile": "88463.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "trigger.CONT_AUTO\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the trigger mode setting after bootup.", - "details": "Conditions must be valid before continuous measurements can start.When the restart parameter is selected, the instrument is placed in local mode, aborts any running scripts, and aborts any trigger models that are running. If the command is in a script, it is the last command that runs before the script is aborted. The restart parameter is not stored in nonvolatile memory, so it does not affect start up behavior.The off and automatic parameters are stored in nonvolatile memory, so they affect start up behavior.", - "param_info": [ - { - "name": "setting", - "description": "Do not start continuous measurements after boot", - "enum": "trigger.CONT_OFF nil|trigger.CONT_AUTO nil|trigger.CONT_RESTART nil", - "type": "triggercontinuoussetting", - "range": "" - } - ], - "usage": [ - "setting = trigger.continuous", - "trigger.continuous = setting" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.continuous = trigger.CONT_OFF;", - "description": "When the instrument starts up, the measurement method is set to idle.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.autorangerebound", - "webhelpfile": "88860.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument restores the measure range to match the limit range after making a measurement.", - "details": "When autorange rebound is enabled, it prevents the source from being limited to a value that is below the source limit. After an autoranged measurement is made, the measure range is restored to match the limit range once the autoranged measurement is complete. This ensures that the source does not limit at less than the full limit setting.", - "param_info": [ - { - "name": "state", - "description": "Do not restore the measurement range after each measurement", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangereboundstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangereboundfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autorangerebound", - "smu.measure.autorangerebound = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_RANGE_REBOUND)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_REBOUND, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;smu.measure.autorangerebound = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n--- --Set the measure range to be automatically restored to match the source limit value after each measurement.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.interlock.enable", - "webhelpfile": "88873.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the output can be turned on when the interlock is not engaged.", - "details": "", - "param_info": [ - { - "name": "state", - "description": "Allow the output to be turned on when the interlock is not engaged", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlockenablestate", - "range": "" - } - ], - "usage": [ - "state = smu.interlock.enable", - "smu.interlock.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "smu.interlock.enable = smu.ON;", - "description": "The source output is disabled unless the interlock is engaged.\n" - } - ], - "related_commands": [ - "smu.interlock.tripped" - ] - }, - { - "name": "available()", - "webhelpfile": "89066.htm", - "signature": "available(functionality)", - "command_return": "presence", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks for the presence of specific instrument functionality.", - "details": "", - "param_info": [ - { - "name": "presence", - "description": "If the functionality is present, returns true; if not, returns false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "functionality", - "description": "The functionality to check for", - "enum": "", - "type": "functionality", - "range": "" - } - ], - "usage": [ - "presence = available(functionality)" - ], - "overloads": [], - "examples": [ - { - "example": "print(available(gpib));", - "description": "Returns true if GPIB communications are available. Returns false if GPIB communications are not available.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.getattribute()", - "webhelpfile": "91266.htm", - "signature": "smu.measure.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuregetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to smu.measure.setattribute() for available settings", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "()" - } - ], - "usage": [ - "value = smu.measure.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_RANGE));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_NPLC));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_DIGITS));", - "description": "Retrieve the range, NPLC, and digits settings for the DC voltage function.\n--- --Example return:\n--- --0.02\n--- --1\n--- --smu.DIGITS_4_5\n" - } - ], - "related_commands": [ - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.measure.configlist.storefunc()", - "webhelpfile": "91273.htm", - "signature": "smu.measure.configlist.storefunc(listName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a measure function into a measure configuration list whether or not the function is active.", - "details": "You must create the configuration list before using this command.If index is not specified, the settings are stored to the next available index in the configuration list.", - "param_info": [ - { - "name": "listName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The measure function settings to save into the configuration list", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.storefunc(listName, function)", - "smu.measure.configlist.storefunc(listName, function, index)" - ], - "overloads": [ - "smu.measure.configlist.storefunc(listName, function)" - ], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);\u00a0;", - "description": "Create a measure configuration list named MyMeasList.\n--- --Store the attributes for the DC Voltage settings in index\u00a01.\n--- --\u00a0\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()", - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.source.configlist.storefunc()", - "webhelpfile": "91274.htm", - "signature": "smu.source.configlist.storefunc(ConfigListName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a source function into a source configuration list whether or not the function is active.", - "details": "The configuration list must be created before you send this function.", - "param_info": [ - { - "name": "ConfigListName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The function to save into the configuration list", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.storefunc(ConfigListName, function)", - "smu.source.configlist.storefunc(ConfigListName, function, index)" - ], - "overloads": [ - "smu.source.configlist.storefunc(ConfigListName, function)" - ], - "examples": [ - { - "example": "smu.source.configlist.create(\"sourcelist\");smu.source.configlist.storefunc(\"sourcelist\", smu.FUNC_DC_CURRENT);", - "description": "Create a configuration list named sourcelist.\n--- --Store the settings for the DC current source function into the configuration list in index 1.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.source.setattribute()", - "webhelpfile": "91275.htm", - "signature": "smu.source.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a source function whether or not the function is active.", - "details": "You can set the following parameters. The links in the list below link to the descriptions of the corresponding TSP command descriptions. The settings available for each parameter are the same as the settings for the TSP commands.The parameters you can set are:", - "param_info": [ - { - "name": "function", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcesetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The parameter to be set; see Details", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "" - }, - { - "name": "value", - "description": "The function or setting value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_RANGE, 0.007);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY, 0.35);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_LEVEL, 0.035);", - "description": "Sets the range, delay, and level settings for DC current, whether or not DC current is the active function.\n" - } - ], - "related_commands": [ - "smu.source.configlist.storefunc()", - "smu.source.getattribute()", - "" - ] - }, - { - "name": "smu.source.getattribute()", - "webhelpfile": "91276.htm", - "signature": "smu.source.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcegetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The setting of the attribute; refer to smu.source.setattribute() for the list of attributes", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "()" - } - ], - "usage": [ - "value = smu.source.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.getattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY));", - "description": "Retrieve the source delay setting for DC current.\n--- --Example return:\n--- --1.05e-07\n" - } - ], - "related_commands": [ - "smu.source.setattribute()" - ] - }, - { - "name": "smu.measure.setattribute()", - "webhelpfile": "91445.htm", - "signature": "smu.measure.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a measure function whether or not the function is active.", - "details": "The lists following the Example and Also See information show the attributes that are available for each function, with links to the descriptions of the corresponding TSP command descriptions. The options for each attribute are the same as the settings for the TSP commands.Limit 1 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_1Limit 1 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_1Limit 1 enable: smu.ATTR_MEAS_LIMIT_ENABLE_1Limit 1 fail: smu.ATTR_MEAS_LIMIT_FAIL_1Limit 1 high value: smu.ATTR_MEAS_LIMIT_HIGH_1Limit 1 low value: smu.ATTR_MEAS_LIMIT_LOW_1Limit 2 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_2Limit 2 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_2Limit 2 enable: smu.ATTR_MEAS_LIMIT_ENABLE_2Limit 2 fail: smu.ATTR_MEAS_LIMIT_FAIL_2Limit 2 high value: smu.ATTR_MEAS_LIMIT_HIGH_2Limit 2 low value: smu.ATTR_MEAS_LIMIT_LOW_2", - "param_info": [ - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuresetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to Details and the tables following the examples", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "" - }, - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_REL_LEVEL, 0.55);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_HIGH_1, 0.64);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_LOW_1, 0.32);smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);", - "description": "Configure the DC Voltage function settings for the relative offset level, limit 1 high value, and limit 1 low value whether or not DC Voltage is the active function.\n--- --Create a configuration list named MyMeasList.\n--- --Store the settings for the DC Voltage function in MyMeasList at index 1.\n" - } - ], - "related_commands": [ - "smu.measure.getattribute()" - ] - } - ] -} \ No newline at end of file diff --git a/data/2460.json b/data/2460.json deleted file mode 100644 index 1ac3f8b..0000000 --- a/data/2460.json +++ /dev/null @@ -1,15041 +0,0 @@ -{ - "commands": [ - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double-beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - }, - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user-defined string catalog.", - "details": "The catalog provides access for user-defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user-defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key-value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user-defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user-defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user-defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "upgrade.previous()", - "webhelpfile": "14062.htm", - "signature": "upgrade.previous()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns to a previous version of the Model 2460 firmware.", - "details": "This function allows you to revert to an earlier version of the firmware.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument performs the upgrade. An error is returned if an upgrade file is not found.", - "param_info": [], - "usage": [ - "upgrade.previous()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "Upgrading the firmware", - "upgrade.unit()" - ] - }, - { - "name": "upgrade.unit()", - "webhelpfile": "14063.htm", - "signature": "upgrade.unit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function upgrades the Model 2460 firmware.", - "details": "When upgrade.unit() is used, the firmware is only loaded if the version of the firmware is newer than the existing version. If the version is older or at the same revision level, it is not upgraded.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument verifies that the file is a newer version. If the version is older or at the same revision level, it is not upgraded, although it does request a reboot. If it is a newer version, the instrument performs the upgrade. An error event message is returned if no upgrade file is found.", - "param_info": [], - "usage": [ - "upgrade.unit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "upgrade.previous()", - "Upgrading the firmware" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));\u00a0;\u00a0;\u00a0;tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.0000000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.0000000e+00\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP-enabled. The Model 2460 does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP-enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP-enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2460 sends an abort command to the remote device on connection. The Model 2460 also enables TSP prompts on the remote device and event management. The Model 2460 places remote errors and events from the TSP-enabled device in its own event queue and prefaces these events with Remote Error, followed by an event description. Do not manually change either the prompt functionality (localnode.prompts) or show events by changing localnode.showerrors or localnode.showevents on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP-enabled.\n" - } - ], - "related_commands": [ - "localnode.prompts", - "localnode.showevents", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP-Net session.\n--- --\u00a0\n--- --Close the session.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2460 decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the Model 2460 suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The Model 2460 places any remotely generated errors and events into its event queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear as:\n--- --KEITHLEY INSTRUMENTS,MODEL 2460,00000170,1.0.0a\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the Model 2460 pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the Model 2460 reads from a TSP-enabled remote instrument, the Model 2460 removes Test Script Processor (TSP\u00ae) prompts and places any errors or events it receives from the remote instrument into its own event queue. The Model 2460 prefaces events and errors from the remote device with Remote Error, followed by the event number and description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");\u00a0;repeat bytes = tspnet.readavailable(ID) until bytes > 0;\u00a0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that will create data.\n--- --\u00a0\n--- --Wait for data to be available.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands. ", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands will wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP-enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP-enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP-enabled instrument.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The Model 2460 sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma-delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "times = tspnet.tsp.rbtablecopy(testTspdevice,; \"testRemotebuffername.timestamps\", 1, 3);print(times);", - "description": "Copy the specified timestamps table for items 1 through 3, then display the table. Example output:\n--- --01/01/2015 10:10:10.0000013,01/01/2015 10:10:10.0000233,01/01/2015 10:10:10.0000576\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount | integer", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newpath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newpath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "18\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "15009.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts on a remote TSP-Link node. ", - "details": "This command is only applicable to TSP-Link systems. You can use this command to use the remote master node to run a script on the specified node. This function does not run test scripts on the master node; only on the subordinate node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x = 5\") to set x equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "related_commands": [ - "tsplink.group" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. ", - "details": "This function retrieves the value of a global variable from the run-time environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "related_commands": [ - "node[N].setglobal()" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2460 \n" - } - ], - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. ", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "related_commands": [ - "node[N].getglobal()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "15057.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex is set to less than 1 or if endIndex is more than the size of the index, 9.910000e+37 is returned for each value outside the allowed index and an event is generated.If overlapped commands use the specified reading buffers and the commands are not complete (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the readings have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data.The output of printbuffer() is affected by the data format selected by format.data. If you set format.data to format.REAL32 or format.REAL64, you have fewer options for buffer elements. With these formats, the only buffer elements available are readings, relativetimestamps, and extravalues. If you request a buffer element that is not permitted for the selected data format, the instrument returns 9.91e37.You can use the bufferVar attributes that are listed in the following table with the print buffer command. For example, if testData is the buffer, you can use testData.dates attribute to print the date of each reading in the testData buffer.You can use bufferVar.n to retrieve the number of readings in the specified reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "Name of first table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(200);format.data = format.ASCII;format.asciiprecision = 6;trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.readings, testData.units, testData.relativetimestamps);", - "description": "Reset the instrument.\n--- --Set the data format and ASCII precision.\n--- --Use trigger model SimpleLoop to create a 6-count loop with no delays that stores data in the reading buffer testBuffer.\n--- --Start the trigger model, wait for the commands to complete, and output the readings.\n--- --Use of testData.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, testBuffer.n equals 6.\n--- --Example of output data: \n--- --1.10458e-11, Amp DC, 0.00000e+00, 1.19908e-11, Amp DC, 1.01858e-01, 1.19908e-11, Amp DC, 2.03718e-01, 1.20325e-11, Amp DC, 3.05581e-01, 1.20603e-11, Amp DC, 4.07440e-01, 1.20325e-11, Amp DC, 5.09299e-01\n" - }, - { - "example": "for x = 1, testData.n do; printbuffer(x,x,testData, testData.units, testData.relativetimestamps);end;", - "description": "Using the same buffer created in Example 1, output the readings, units and relative timestamps on a separate line for each reading.\n--- --1.10458e-11, Amp DC, 0.00000e+00\n--- --1.19908e-11, Amp DC, 1.01858e-01\n--- --1.19908e-11, Amp DC, 2.03718e-01\n--- --1.20325e-11, Amp DC, 3.05581e-01\n--- --1.20603e-11, Amp DC, 4.07440e-01\n--- --1.20325e-11, Amp DC, 5.09299e-01\n" - } - ], - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.54000000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP-Link node. ", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "2\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. ", - "details": "This command sets the TSP-Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP-Link instrument or tsplink.initialize() is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP-Link node for this instrument to number\u00a03.\n" - } - ], - "related_commands": [ - "tsplink.initialize() ", - "tsplink.state" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. ", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "related_commands": [ - "Triggering using TSP-Link trigger lines", - "tsplink.line[N].state", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP-Link online state. ", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.initialize() or tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "\"online\" | \"offline\"", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP-Link system. If it is online, the output is:\n--- --online\n" - } - ], - "related_commands": [ - "tsplink.initialize()", - "tsplink.node" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP-Link synchronization lines as a digital I/O port. ", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "related_commands": [ - "tsplink.line[N].state" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean | true | false", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that will be used the next time the timer is triggered.If you use the trigger timer with a trigger model, make sure the trigger timer delay is set so that the readings are paced correctly.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (8 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(8 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be >=\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};\u00a0;DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --\u00a0\n--- --Read the delay list on trigger timer\u00a03.\n--- --\u00a0\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event or is enabled as a timer or alarm.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - }, - { - "example": "reset();trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;\u00a0;trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY8);trigger.model.setblock(3, trigger.BLOCK_WAIT, trigger.EVENT_TIMER4);trigger.model.setblock(4, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 20, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the trigger timer 4 stimulus to off.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n--- --\u00a0\n--- --Clear the trigger model.\n--- --Set trigger model block 1 to clear the buffer.\n--- --Set trigger model block 2 to generate the notify 8 event.\n--- --Set trigger model block 3 to wait for the trigger timer 4 to occur.\n--- --Set trigger model block 4 to make a measurement and store it in default buffer 1.\n--- --Set trigger model block 5 to repeat the trigger model 20 times, starting at block 3.\n--- --Start the trigger model.\n--- --Wait until all commands are complete.\n--- --Print the number of entries in default buffer 1.\n--- --\u00a0\n--- --Output:\n--- --20\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified, the script is saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.If you set scriptVar to autoexec, the script is run when the instrument powers up. You must delete the existing autoexec script before saving the new one. Note that performing a system reset does not delete the autoexec script.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB flash drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "related_commands": [ - "Working with scripts" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "smu.measure.func", - "webhelpfile": "25622.htm", - "signature": "", - "command_return": "mFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_CURRENT\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the active measure function.", - "details": "Set this command to the type of measurement you want to make.Reading this command returns the measure function that is presently active.When you select a function, settings for other commands that are related to the function become active. For example, assume that:If you return to the current function, the math function returns to reciprocal. If you then switch from the current function to the voltage function, the math function returns to percent. All attributes that begin with smu.measure. are saved with the active measure function unless otherwise indicated in the command description.", - "param_info": [ - { - "name": "mFunction", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefuncmFunction", - "range": "" - } - ], - "usage": [ - "mFunction = smu.measure.func", - "smu.measure.func = mFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;print(smu.measure.math.format);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.math.format);", - "description": "Sets the instrument to measure voltage and set the math format to percent and enable the math functions.\n--- --Set the instrument to measure resistance and set the math format to reciprocal and enable the math functions.\n--- --Print the math format while the resistance measurement function is selected. The output is:\n--- --smu.MATH_RECIPROCAL\n--- --Change the function to voltage. Print the math format. The output is:\n--- --smu.MATH_PERCENT\n" - } - ], - "related_commands": [ - "Source and measure using TSP commands" - ] - }, - { - "name": "buffer.getstats()", - "webhelpfile": "25624.htm", - "signature": "buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "command_return": "statsVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns statistics from a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that was placed in the reading buffer.The instrument automatically updates reading buffer statistics as data is added to the reading buffer.When the reading buffer is configured to fill continuously and overwrite old data with new data, the buffer statistics include the data that was overwritten. To get statistics that do not include data that has been overwritten, define a large buffer size that will accommodate the number of readings you will make. The table returned from this function provides statistics at the time the function is called. Although the instrument continues to update the statistics, the table that is returned is not updated. To get fresh statistics, call this function again.The statsVar parameter contains the values described in the following table.If n equals zero (0), all other values are nil. If n equals 1, stddev is nil because the standard deviation of a sample size of 1 is undefined.Use the following command to get values from statsVar; a table with the following entries in it: n, min, max, mean, and stddev:Use the following commands to print these entries:", - "param_info": [ - { - "name": "statsVar", - "description": "A table that contains the entries for buffer statistics; see Details for information on the entries", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "absStartTime", - "description": "An integer that represents the absolute start time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absStartFractional", - "description": "An integer that represents the portion of the absolute start time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndTime", - "description": "An integer that represents the absolute end time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndFractional", - "description": "An integer that represents the portion of the absolute end time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relStartTime", - "description": "The start time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relEndTime", - "description": "The end time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "overloads": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 12, 0.001, defbuffer1);trigger.model.initiate();waitcomplete();\u00a0;stats = buffer.getstats(defbuffer1);print(stats);", - "description": "Reset the instrument.\n--- --Set up the SimpleLoop trigger-model template to make 12 readings with a 0.001\u00a0s delay. Readings are stored in defbuffer1.\n--- --Start the trigger model.\n--- --Assign the name stats to the table.\n--- --Get statistics for the default reading buffer named defbuffer1.\n--- --Example output:\n--- --[\"min\"]={[\"seconds\"]=1561123956, [\"fractionalseconds\"]=0.010184587, [\"timestamp\"]=1561123956, [\"reading\"]=8.4974199416e-05}, [\"mean\"]=0.000132948335, [\"stddev\"]=4.4270141937e-05, [\"max\"]={[\"seconds\"]=1561123955, [\"fractionalseconds\"]=0.833083981, [\"timestamp\"]=1561123955.8, [\"reading\"]=0.0002192359033}, [\"n\"]=12\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.model.abort()", - "webhelpfile": "25628.htm", - "signature": "trigger.model.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stops all trigger model commands on the instrument.", - "details": "When this command is received, the instrument stops the trigger model.", - "param_info": [ - { - "name": "trigger.model.abort()", - "description": "Terminates all commands related to the trigger model on the instrument.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.abort();", - "description": "Terminates all commands related to the trigger model on the instrument.\n" - } - ], - "related_commands": [ - "Effect of GPIB line events on Model 2460", - "Aborting the trigger model" - ] - }, - { - "name": "buffer.make()", - "webhelpfile": "25629.htm", - "signature": "buffer.make(bufferSize, style)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a user-defined reading buffer.", - "details": "You cannot assign user-defined reading buffers the name defbuffer1 or defbuffer2. In addition, the buffer name must not already exist as a global variable, a local variable, table, or array.If you create a reading buffer that has the same name as an existing user-defined buffer, the existing buffer is overwritten by the new buffer. Any data in the existing buffer is lost.When you create a reading buffer, it becomes the active buffer. If you create two reading buffers, the last one you create becomes the active buffer.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.The default fill mode of a user-defined buffer is once. You can change it to continuous later.Once the buffer style is selected, it cannot be changed.Once you store the first reading in a compact buffer, you cannot change certain measurement settings, including range, display digits, and units; you must clear the buffer first.Not all remote commands are compatible with the compact, writable, and full writable buffer styles. Check the Details section of the command descriptions before using them with any of these buffer styles.Writable reading buffers are used to bring external data into the instrument. You cannot assign them to collect data from the instrument.You can change the buffer capacity for an existing buffer through the front panel or by using the bufferVar.capacity command.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferSize", - "description": "The maximum number of readings that can be stored in bufferVar; minimum is\u00a010; 0 to maximize buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "style", - "description": "The type of reading buffer to create", - "enum": "buffer.STYLE_COMPACT nil|buffer.STYLE_STANDARD nil|buffer.STYLE_FULL nil|buffer.STYLE_WRITABLE nil|buffer.STYLE_WRITABLE_FULL nil", - "type": "buffermakestyle", - "range": "" - } - ], - "usage": [ - "bufferVar = buffer.make(bufferSize)", - "bufferVar = buffer.make(bufferSize, style)" - ], - "overloads": [ - "bufferVar = buffer.make(bufferSize)" - ], - "examples": [ - { - "example": "capTest2\u00a0= buffer.make(200, buffer.STYLE_FULL);", - "description": "Creates a 200-element reading buffer that stores readings with full accuracy named capTest2.\n" - } - ], - "related_commands": [ - "bufferVar.capacity", - "bufferVar.fillmode", - "buffer.write.format()", - "buffer.write.reading()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "25630.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the specified reading buffer.", - "details": "You can call this command to return the number of readings stored in the specified reading buffer.You can use the bufferVar.n attribute in other commands. For example, to print all the readings in a buffer, use the following command:Where bufferVar is the name of the buffer to use.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the reading buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(100);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.n);print(defbuffer1.n);print(defbuffer2.n);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the number of readings in testData.\n--- --Output:\n--- --3\n--- --Print the number of readings in defbuffer1.\n--- --Example output:\n--- --0\n--- --Print the number of readings in defbuffer2.\n--- --Example output:\n--- --0\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "timer.gettime()", - "webhelpfile": "25635.htm", - "signature": "timer.gettime()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function measures the elapsed time since the timer was last cleared.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.cleartime()" - ] - }, - { - "name": "timer.cleartime()", - "webhelpfile": "25636.htm", - "signature": "timer.cleartime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "dataqueue.clear()dataqueue.add(35)timer.cleartime()delay(0.5)dt = timer.gettime()print(\"Delay time was \" .. dt)print(dataqueue.next())", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.cleartime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.gettime()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "25637.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending command triggers.", - "details": "A command trigger indicates if a trigger event has been detected over a command interface since the last trigger.wait() command was sent. Command triggers are generated by:trigger.clear() clears the command triggers and discards the history of trigger events.", - "param_info": [ - { - "name": "*TRGprint(trigger.wait(1))trigger.clear()print(trigger.wait(1))", - "description": "Generate a trigger event.Check if there are any pending trigger events. Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "*TRG;print(trigger.wait(1));trigger.clear();print(trigger.wait(1));", - "description": "Generate a trigger event.\n--- --Check if there are any pending trigger events. \n--- --Output: true\n--- --Clear any pending command triggers.\n--- --Check if there are any pending trigger events.\n--- --Output: false\n" - } - ], - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "25639.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "A trigger was detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "bufferVar.formattedreadings", - "webhelpfile": "25640.htm", - "signature": "bufferVar.formattedreadings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the stored readings shown as numbers with units and prefixes.", - "details": "This read-only attribute is an array that contains the stored readings. The readings are shown as numbers with prefixes before the units symbol.", - "param_info": [ - { - "name": "reading", - "description": "Buffer reading formatted with numbers and prefixes with units for element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.formattedreadings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.formattedreadings[1]);printbuffer(1, testData.n, testData.formattedreadings);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading.\n--- --Example output:\n--- --+00.0028 nA\n--- --Print all readings in the reading buffer.\n--- --Example output:\n--- --+00.0028 nA, +00.0039 nA, +00.0040 nA\n" - } - ], - "related_commands": [ - "bufferVar.readings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.units", - "webhelpfile": "25641.htm", - "signature": "bufferVar.units[N]", - "command_return": "readingUnit", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "details": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "param_info": [ - { - "name": "readingUnit", - "description": "Volt DC", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingUnit = bufferVar.units[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);testData.fillmode = buffer.FILL_CONTINUOUS;smu.measure.func = smu.FUNC_DC_CURRENT;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the buffer to fill continuously.\n--- --Set the measure function to current.\n--- --Make three readings.\n--- --Print the units for the readings.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the measure function to voltage.\n--- --Make three readings.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.saveappend()", - "webhelpfile": "25642.htm", - "signature": "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function appends data from the reading buffer to a file on the USB flash drive.", - "details": "If the file you specify does not exist on the USB flash drive, this command creates the file.For options that save more than one item of time information, each item is comma-delimited. For example, the default format is date, time, and fractional seconds for each reading.The file extension .csv is appended to the file name if necessary. Any file extension other than .csv generates an error.The index column entry in the .csv file starts at 1 for each append operation.Examples of valid destination file names:Invalid destination file name examples:\u2014 The period is not followed by csv.\u2014 The only allowed extension is .csv. If .csv is not assigned, it is automatically added.", - "param_info": [ - { - "name": "bufferVar", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Indicates how date and time information from the buffer is saved in the file on the USB flash drive; the options are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersaveappendtimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)", - "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)" - ], - "overloads": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)" - ], - "examples": [ - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myData.csv\");", - "description": "Append reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Append readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash\u00a0drive.\n" - }, - { - "example": "reset();if file.usbdriveexists() == 1 then; testDir = \"TestData11\";-- Create a directory on the USB drive for the data.; file.mkdir(testDir);-- Build the full file and path.; fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";-- Open the file where the data will be stored.; fileNumber = file.open(fileName, file.MODE_WRITE);-- Write the string data to a file.; file.write(fileNumber, \"Tested to Company Standard ABC.101\\n\");-- Write the header separator to a file.; file.write(fileNumber, \"====================================================================\\n\");-- Write the string data to a file.; file.write(fileNumber, \"\\t1. Connect HI/LO to respective DUT terminals.\\n\"); file.write(fileNumber, \"\\t2. Set power supply to 5 VDC @ 1 A.\\n\"); file.write(fileNumber, \"\\t3. Wait 30 minutes.\\n\"); file.write(fileNumber, \"\\t4. Capture 100 readings and analyze data.\\n\\n\\n\");-- Write buffering data to a file.; file.flush(fileNumber);-- Close the data file.; file.close(fileNumber);end;-- Fix the range to 10 V.;smu.measure.range = 10.0;-- Set the measurement count to 100.;smu.measure.count = 100;-- Set up reading buffers.;-- Ensure the default measurement buffer size matches the count.;defbuffer1.capacity = smu.measure.count;smu.measure.read();buffer.saveappend(defbuffer1, fileName);", - "description": "Write string data to a file with information about a test file.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.save()" - ] - }, - { - "name": "smu.measure.math.enable", - "webhelpfile": "25644.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables math operations on measurements for the selected measurement function.", - "details": "When this command is set to on, the math operation specified by the math format command is performed before completing a measurement.", - "param_info": [ - { - "name": "value", - "description": "The math enable setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasuremathenablevalue", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathenablefunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.enable", - "smu.measure.math.enable = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_ENABLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;", - "description": "When voltage measurements are made, the math format is enabled and set to percent.\n" - } - ], - "related_commands": [ - "smu.measure.math.format" - ] - }, - { - "name": "smu.measure.rel.acquire()", - "webhelpfile": "25645.htm", - "signature": "smu.measure.rel.acquire()", - "command_return": "relativeValue", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function acquires a measurement and stores it as the relative offset value.", - "details": "This command triggers the instrument to make a new measurement for the selected function. This measurement is then stored as the new relative offset level.When you send this command, the instrument does not apply any math, limit test, or filter settings to the measurement, even if they are set. It is a measurement that is made as if these settings are disabled.If an error event occurs during the measurement, nil is returned and the relative offset level remains at the last valid setting.You must change to the function for which you want to acquire a value before sending this command.The instrument must have relative offset enabled to use the acquired relative offset value.After executing this command, you can use the smu.measure.rel.level attribute to see the last relative level value that was acquired or that was set.", - "param_info": [ - { - "name": "relativeValue", - "description": "The internal measurement acquired for the relative offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "relativeValue = smu.measure.rel.acquire()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.enable", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.limit[Y].autoclear", - "webhelpfile": "25682.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the test result for limit Y should be cleared automatically or not.", - "details": "When auto clear is set to on, limit conditions are cleared automatically after each measurement. If you are making a series of measurements, the instrument shows the limit test result of the last measurement for the pass or fail indication for the limit.If you want to know if any of a series of measurements failed the limit, set the auto clear setting to off. When this is set to off, a failed indication is not cleared automatically. It remains set until it is cleared with the clear command.The auto clear setting affects both the high and low limits.", - "param_info": [ - { - "name": "value", - "description": "The auto clear setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitautoclearvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitautoclearfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].autoclear = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[1].autoclear = smu.ON;", - "description": "Turns on autoclear for limit 1 when measuring DC current.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].clear()" - ] - }, - { - "name": "smu.measure.limit[Y].clear()", - "webhelpfile": "25683.htm", - "signature": "smu.measure.limit[Y].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the results of the limit test defined by Y for the selected measurement function.", - "details": "Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared.To avoid the need to manually clear the test results for a limit, turn the auto clear option on.", - "param_info": [ - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.limit[Y].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[2].clear();", - "description": "Clears the test result for the high and low limit 2 for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear" - ] - }, - { - "name": "smu.measure.limit[Y].fail", - "webhelpfile": "25684.htm", - "signature": "", - "command_return": "result", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute queries the results of a limit test.", - "details": "This command queries the result of a limit test for the selected measurement function.The response message indicates if the limit test passed or how it failed (on the high or low limit).If autoclear is set to off, reading the results of a limit test does not clear the fail indication of the test. To clear a failure, send the clear command. To automatically clear the results, set auto clear on.If auto clear is set to on and you are making a series of measurements, the last measurement limit determines the fail indication for the limit. If auto clear is turned off, the results return a test fail if any of one of the readings failed.To use this attribute, you must set the limit state to on.If the readings are stored in a reading buffer, you can use the bufferVar.statuses command to see the results.This example enables limits 1 and 2 for voltage, measurements. Limit 1 is checking for readings to be between 3 and 5 V, while limit\u00a02 is checking for the readings to be between 1 and 7 V. The auto clear feature is disabled, so if any reading is outside these limits, the corresponding fail is 1. Therefore, if any one of the fails is 1, analyze the reading buffer data to find out which reading failed the limits.", - "param_info": [ - { - "name": "result", - "description": "The results of the limit test for limit Y", - "enum": "smu.FAIL_NONE nil|smu.FAIL_HIGH nil|smu.FAIL_LOW nil|smu.FAIL_BOTH nil", - "type": "smumeasurelimitfailresult", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitfailfunction", - "range": "" - } - ], - "usage": [ - "result = smu.measure.limit[Y].fail", - "result = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_FAIL_Y)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();-- set the instrument source current;smu.source.func = smu.FUNC_DC_CURRENT;-- set the instrument to measure voltage;smu.measure.func = smu.FUNC_DC_VOLTAGE;-- set the range to 10 V;smu.measure.range = 10;-- set the nplc to 0.1;smu.measure.nplc = 0.1;-- disable auto clearing for limit 1;smu.measure.limit[1].autoclear = smu.OFF;-- set high limit on 1 to fail if reading exceeds 5 V;smu.measure.limit[1].high.value = 5;-- set low limit on 1 to fail if reading is less than 3 V;smu.measure.limit[1].low.value = 3;--- set the beeper to sound if the reading exceeds the limits for limit 1;smu.measure.limit[1].audible = smu.AUDIBLE_FAIL;-- enable limit 1 checking for voltage measurements;smu.measure.limit[1].enable = smu.ON;-- disable auto clearing for limit 2;smu.measure.limit[2].autoclear = smu.OFF;-- set high limit on 2 to fail if reading exceeds 7 V;smu.measure.limit[2].high.value = 7;-- set low limit on 2 to fail if reading is less than 1 V;smu.measure.limit[2].low.value = 1;-- enable limit 2 checking for voltage measurements;smu.measure.limit[2].enable = smu.ON;-- set the measure count to 50;smu.measure.count = 50;-- create a reading buffer that can store 100 readings;LimitBuffer = buffer.make(100);-- make 50 readings and store them in LimitBuffer;smu.measure.read(LimitBuffer);-- Check if any of the 50 readings were outside of the limits;print(\"limit 1 results = \" .. smu.measure.limit[1].fail);print(\"limit 2 results = \" .. smu.measure.limit[2].fail);-- clear limit 1 conditions;smu.measure.limit[1].clear();-- clear limit 2 conditions;smu.measure.limit[2].clear();", - "description": "Example output that shows all readings are within limit values (all readings between 3 V and 5 V):\n--- --limit 1 results = smu.FAIL_NONE\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 high values (a 6\u00a0V reading would cause this condition or a reading greater than 5 V but less than 7 V):\n--- --limit 1 results = smu.FAIL_HIGH\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 and 2 low values (a 0.5 V reading would cause this condition or a reading less than 1\u00a0V):\n--- --limit 1 results = smu.FAIL_LOW\n--- --limit 2 results = smu.FAIL_LOW\n" - } - ], - "related_commands": [ - "bufferVar.statuses", - "Limit testing and binning", - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].high.value", - "webhelpfile": "25685.htm", - "signature": "", - "command_return": "highLimit", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the upper limit for a limit test.", - "details": "This command sets the high limit for the limit Y test for the selected measurement function. When limit Y testing is enabled, the instrument generates a fail indication when the measurement value is more than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "highLimit", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)", - "enum": "", - "type": "number", - "range": "(-9.99999e+11 to +9.99999e+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimithighvaluefunction", - "range": "" - } - ], - "usage": [ - "highLimit = smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].high.value = highLimit", - "highLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_HIGH_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_HIGH_Y, highLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "highLimit;", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].low.value", - "webhelpfile": "25686.htm", - "signature": "", - "command_return": "lowLimit", - "type": "Attribute (RW)", - "default_value": "-1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the lower limit for limit tests.", - "details": "This command sets the lower limit for the limit Y test for the selected measure function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "lowLimit", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)", - "enum": "", - "type": "number", - "range": "(-9.99999E+11 to 9.99999E+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitlowvaluefunction", - "range": "" - } - ], - "usage": [ - "lowLimit = smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].low.value = lowLimit", - "lowLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_LOW_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_LOW_Y, lowLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "lowLimit;", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.math.format", - "webhelpfile": "25687.htm", - "signature": "", - "command_return": "operation", - "type": "Attribute (RW)", - "default_value": "smu.MATH_PERCENT\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which math operation is performed on measurements when math operations are enabled.", - "details": "This specifies which math operation is performed on measurements for the selected measurement function.You can choose one of the following math operations:Math calculations are applied to the input signal after relative offset and before limit tests.", - "param_info": [ - { - "name": "operation", - "description": "Math operation to be performed on measurements", - "enum": "smu.MATH_MXB nil|smu.MATH_PERCENT nil|smu.MATH_RECIPROCAL nil", - "type": "smumeasuremathformatoperation", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathformatfunction", - "range": "" - } - ], - "usage": [ - "operation = smu.measure.math.format", - "smu.measure.math.format = operation", - "operation = smu.measure.getattribute(function, ATTR_MEAS_MATH_FORMAT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_FORMAT, operation)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;", - "description": "Enables the reciprocal math operation on voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.mfactor", - "smu.measure.math.percent" - ] - }, - { - "name": "smu.measure.read()", - "webhelpfile": "25688.htm", - "signature": "smu.measure.read(bufferName)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes measurements, places them in a reading buffer, and returns the last reading.", - "details": "This function makes a measurement using the present function setting, stores the reading in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed. You can also use the trigger model Simple Loop.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is defined, it defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading = smu.measure.read()", - "reading = smu.measure.read(bufferName)" - ], - "overloads": [ - "reading = smu.measure.read()" - ], - "examples": [ - { - "example": "voltMeasBuffer = buffer.make(10000);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.read(voltMeasBuffer));", - "description": "Create a buffer named voltMeasBuffer. Set the instrument to measure voltage.\n--- --Make a measurement that is stored in the voltMeasBuffer and is also printed.\n" - } - ], - "related_commands": [ - "buffer.make()", - "smu.measure.count", - "smu.measure.unit", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.measure.configlist.create()", - "webhelpfile": "25691.htm", - "signature": "smu.measure.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty measure configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");", - "description": "Create a measure configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.catalog()", - "smu.measure.configlist.delete()", - "smu.measure.configlist.query()", - "smu.measure.configlist.recall()", - "smu.measure.configlist.size()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.store()", - "webhelpfile": "25693.htm", - "signature": "smu.source.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active source settings into the named configuration list.", - "details": "Use this command to store the active source settings to a configuration index in a configuration list. If the index is defined, the configuration list is stored in that index. If the index is not defined, the configuration index is appended to the end of the list. If a configuration index already exists for the specified index, the new configuration overwrites the existing configuration index.Refer to Settings stored in a source configuration index for information about the settings this command stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.store(listName)", - "smu.source.configlist.store(listName, index)" - ], - "overloads": [ - "smu.source.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.store(\"MyConfigList\");", - "description": "Store the active settings of the instrument to the source configuration list MyConfigList. Settings are saved at the end of the list since no index parameter is specified.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.configlist.catalog()", - "webhelpfile": "25695.htm", - "signature": "smu.source.configlist.catalog()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one source configuration list.", - "details": "You can use this command to retrieve the names of source configuration lists that are stored in the instrument.This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no source configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "print(smu.source.configlist.catalog())", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.catalog());", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.create()", - "webhelpfile": "25696.htm", - "signature": "smu.source.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty source configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. If you want to save a configuration list through a power cycle, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;\u00a0;smu.source.configlist.create(\"MyScrList\");\u00a0;print(smu.source.configlist.catalog());\u00a0;print(smu.source.configlist.catalog());\u00a0;\u00a0;\u00a0;smu.source.configlist.store(\"MyScrList\");smu.source.configlist.store(\"MyScrList\");print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Create a source configuration list named MyScrLst.\n--- --Print the name of one configuration list stored in volatile memory.\n--- --Output:\n--- --MyScrList\n--- --Print the name of one configuration list.\n--- --Output:\n--- --nil\n--- --Nil indicates that no more configuration lists are stored.\n--- --Store a configuration index in MyScrList.\n--- --Store a configuration index in MyScrList.\n--- --Print the number of configuration indexes in MyScrList.\n--- --Output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.delete()", - "webhelpfile": "25697.htm", - "signature": "smu.source.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a source configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.delete(listName)", - "smu.source.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.source.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.delete(\"mySourceList\");", - "description": "Deletes a configuration list named mySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.query()", - "webhelpfile": "25698.htm", - "signature": "smu.source.configlist.query(listName, index, fieldSeparator)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command can only return data for one configuration index. To get data for additional configuration indexes, resend the command and specify different configuration indexes. Refer to Settings stored in a source configuration list for a complete list of source settings that the instrument stores in a source configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list; the default is the first index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.query(listName, index)", - "smu.source.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "smu.source.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(smu.source.configlist.query(\"MyScrList\", 2));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.size()", - "webhelpfile": "25700.htm", - "signature": "smu.source.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of configuration indexes in a source configuration list.", - "details": "The size of the list is equal to the number of configuration indexes in a configuration list.", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total quantity of indexes stored in the specified source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.source.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Determine the number of configuration indexes in a source configuration list named MyScrList.\n--- --Example output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "eventlog.save()", - "webhelpfile": "25702.htm", - "signature": "eventlog.save(filename, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the event log to a file on a USB flash drive.", - "details": "This command saves all event log entries to a USB flash drive.If you do not define an event type, the instrument saves all event log entries.The extension .csv is automatically added to the file name.", - "param_info": [ - { - "name": "filename", - "description": "A string that represents the name of the file to be saved", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsaveeventType", - "range": "" - } - ], - "usage": [ - "eventlog.save(filename)", - "eventlog.save(filename, eventType)" - ], - "overloads": [ - "eventlog.save(filename)" - ], - "examples": [ - { - "example": "eventlog.save(\"/usb1/WarningsApril\", eventlog.SEV_WARN);", - "description": "Save warning messages to a .csv file on a USB flash drive.\n" - } - ], - "related_commands": [ - "eventlog.next()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "25706.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This command allows you to change or view how many readings a buffer can store. Changing the size of a buffer will cause any existing data in the buffer to be lost.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store; set to 0 to maximize the buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity", - "bufferVar.capacity = bufferCapacity" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(500);capTest = buffer.make(300);bufferCapacity = capTest.capacity;\u00a0;print(bufferCapacity);\u00a0;\u00a0;print(testData.capacity);\u00a0;\u00a0;testData.capacity = 600;print(testData.capacity);print(defbuffer1.capacity);", - "description": "Create two user-defined reading buffers: testData and capTest.\n--- --\u00a0\n--- --Create a variable called bufferCapacity to hold the capacity of the capTest buffer.\n--- --Print bufferCapacity.\n--- --Output:\n--- --300\n--- --Print the capacity of testData.\n--- --Output:\n--- --500\n--- --Changes the capacity of testData to 600.\n--- --Print the capacity of testData.\n--- --Output:\n--- --600\n--- --Print the capacity of the default buffer defbuffer1.\n--- --Output:\n--- --10000\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourceunits", - "webhelpfile": "25707.htm", - "signature": "bufferVar.sourceunits[N]", - "command_return": "readingUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of measure of the source.", - "details": "The attribute is an array (a Lua table) of strings indicating the units of measure at the time of the reading.", - "param_info": [ - { - "name": "readingUnits", - "description": "The units of measure of the source", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "readingUnits = bufferVar.sourceunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;testData.fillmode = buffer.FILL_CONTINUOUS;trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_CURRENT;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);smu.source.output = smu.OFF;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source output to ON.\n--- --Set the buffer to fill continuously.\n--- --Set the source function to current.\n--- --Take three readings.\n--- --Print the units for the first three readings in the buffer.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the source function to voltage.\n--- --Take three readings.\n--- --Print the units for the readings in the buffer.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "bufferVar.sourceunits", - "bufferVar.sourcevalues", - "bufferVar.statuses" - ] - }, - { - "name": "bufferVar.relativetimestamps", - "webhelpfile": "25712.htm", - "signature": "bufferVar.relativetimestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamps, in seconds, when each reading occurred, relative to the timestamp of the first entry in the reading buffer.", - "details": "This read-only attribute is an array of timestamps, in seconds, of when each reading occurred relative to the timestamp of the first entry in the reading buffer. These timestamps are equal to the time that has lapsed for each reading since the first reading was stored in the buffer. Therefore, the relative timestamp for the first entry number in the reading buffer equals 0.", - "param_info": [ - { - "name": "timestamp", - "description": "The timestamp, in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timestamp = bufferVar.relativetimestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.relativetimestamps[1]);printbuffer(1, 3, testData.relativetimestamps);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --\u00a0\n--- --Print the relative timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0\n--- --Print the relative timestamp for the reading 1 through 3 in the buffer.\n--- --Example output:\n--- --0, 0.383541, 0.772005\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.seconds", - "webhelpfile": "25713.htm", - "signature": "bufferVar.seconds[N]", - "command_return": "nonFracSeconds", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp of a reading in seconds, in UTC format.", - "details": "This attribute contains the nonfractional seconds portion of the timestamp when the reading was stored in Coordinated Universal Time (UTC) format.The nonfractional seconds portion of the timestamp gives the lowest resolution down to 1 second. To access additional resolution of a timestamp, see bufferVar.fractionalseconds.", - "param_info": [ - { - "name": "nonFracSeconds", - "description": "The nonfractional seconds portion of the timestamp when the reading was stored", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "nonFracSeconds = bufferVar.seconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 6, testData.seconds);", - "description": "Create a reading buffer named testData, configure the instrument to make six measurements, and store the readings in the buffer.\n--- --Print the seconds portion for readings 1 to 6 in testData. \n--- --Example output:\n--- --1362261492, 1362261492, 1362261493, 1362261493, 1362261493, 1362261494\n" - } - ], - "related_commands": [ - "bufferVar.fractionalseconds", - "bufferVar.relativetimestamps" - ] - }, - { - "name": "bufferVar.times", - "webhelpfile": "25715.htm", - "signature": "bufferVar.times[N]", - "command_return": "readingTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the time when the instrument made the reading.", - "details": "", - "param_info": [ - { - "name": "readingTime", - "description": "The time of the reading in hours, minutes, and seconds", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTime = bufferVar.times[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.times[1]);printbuffer(1, 3, testData.times);", - "description": "This example creates a reading buffer named testData and makes three measurements.\n--- --The print() command outputs the time of the first reading. \n--- --Output:\n--- --23:09:43\n--- --The printbuffer() command outputs the time of readings 1 to 3 in the reading buffer. \n--- --Output:\n--- --23:09:43, 23:09:43, 23:09:43\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "25716.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "readingTimestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "This attribute contains the timestamps (date, hours, minutes, seconds, and fractional seconds) of readings stored in the reading buffer.", - "param_info": [ - { - "name": "readingTimestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "string[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTimestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.timestamps[1]);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Output:\n--- --03/01/2018 14:46:07.714614838\n" - }, - { - "example": "for x = 1, 3 do printbuffer(x, x, testData.timestamps) end;", - "description": "For the buffer created in Example 1, print the timestamps for the readings.\n--- --Output:\n--- --03/01/2018 14:46:07.71461483803/01/2018 14:46:08.10046883803/01/2018 14:46:08.487631838\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.readingformat", - "webhelpfile": "25719.htm", - "signature": "", - "command_return": "format", - "type": "Attribute (RW)", - "default_value": "display.FORMAT_PREFIX\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the format that is used to display measurement readings on the front-panel display of the instrument.", - "details": "This setting persists through reset() and power cycles.When Prefix is selected, prefixes are added to the units symbol, such as k (kilo) or m (milli). When Exponent is selected, exponents are used instead of prefixes. When the prefix option is selected, very large or very small numbers may be displayed with exponents.", - "param_info": [ - { - "name": "format", - "description": "Use exponent format", - "enum": "display.FORMAT_EXPONENT nil|display.FORMAT_PREFIX nil", - "type": "displayreadingformatformat", - "range": "" - } - ], - "usage": [ - "format = display.readingformat", - "display.readingformat = format" - ], - "overloads": [], - "examples": [ - { - "example": "display.readingformat = display.FORMAT_EXPONENT;", - "description": "Change front-panel display to show readings in exponential format.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "25722.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function defines the text that is displayed on the front-panel USER swipe screen.", - "details": "This command defines text messages for the USER swipe screen.If you enter too many characters, the instrument displays a warning event and shortens the message to fit.When the instrument is reset, the user test is removed and the USER swipe screen is hidden until another message is defined.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "displayArea", - "description": "display.TEXT1 display.TEXT2", - "enum": "display.TEXT1 nil|display.TEXT2 nil", - "type": "displaysettextdisplayArea", - "range": "" - }, - { - "name": "text", - "description": "String that contains the message for the top line of the USER swipe screen (up to 20 characters)", - "enum": "", - "type": "string", - "range": "(up to 20 characters)" - } - ], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"A122 \\185 A123\");display.settext(display.TEXT2, \"Results in \\018\");", - "description": "Clear the USER swipe screen.\n--- --Display the USER swipe screen.\n--- --Set the first line to read \"A122 \u0394 A123\" and the second line to display \"\"Results in \u03a9\":\n--- --\n" - } - ], - "related_commands": [ - "display.clear()", - "display.changescreen()" - ] - }, - { - "name": "file.mkdir()", - "webhelpfile": "25723.htm", - "signature": "file.mkdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a directory at the specified path on the USB flash drive.", - "details": "The directory path must be absolute. The name of the directory must not already exist on the flash drive.", - "param_info": [ - { - "name": "path", - "description": "A string that contains the path of the directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.mkdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "file.mkdir(\"TestData\");", - "description": "Create a new directory named TestData.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.open()", - "webhelpfile": "25724.htm", - "signature": "file.open(fileName, accessType)", - "command_return": "fileNumber", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file on the USB flash drive for later reference.", - "details": "The path to the file to open must be absolute.The root folder of the USB flash drive has the following absolute path:", - "param_info": [ - { - "name": "fileNumber", - "description": "A number identifying the open file that you use with other file commands to write, read, flush, or close the file after opening", - "enum": "", - "type": "file_object", - "range": "" - }, - { - "name": "fileName", - "description": "A string that contains the file name to open, including the full path of file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "accessType", - "description": "The type of action to do", - "enum": "file.MODE_APPEND nil|file.MODE_READ nil|file.MODE_WRITE nil", - "type": "fileopenaccessType", - "range": "" - } - ], - "usage": [ - "fileNumber = file.open(fileName, accessType)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.ipconfig()", - "webhelpfile": "25725.htm", - "signature": "lan.ipconfig()", - "command_return": "method, ipV4Address, subnetMask, gateway", - "type": "Function", - "default_value": "lan.MODE_AUTO\n", - "tsp_link": "No\n", - "description": "This function specifies the LAN configuration for the instrument.", - "details": "This command specifies how the LAN IP address and other LAN settings are assigned. If automatic configuration is selected, the instrument automatically determines the LAN information. When method is automatic, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, an error occurs.If manual is selected, you must define the IP address. You can also assign a subnet mask, and default gateway. The IP address, subnet mask, and default gateway must be formatted in four groups of numbers, each separated by a decimal. If you do not specify a subnet mask or default gateway, the previous settings are used.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.MODE_AUTO nil|lan.MODE_MANUAL nil", - "type": "lanipconfigmethod", - "range": "" - }, - { - "name": "ipV4Address", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "subnetMask", - "description": "The LAN subnet mask; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "gateway", - "description": "The LAN default gateway; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "method, ipV4Address, subnetMask, gateway = lan.ipconfig()", - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "overloads": [ - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "examples": [ - { - "example": "lan.ipconfig(lan.MODE_AUTO);print(lan.ipconfig());lan.ipconfig(lan.MODE_MANUAL, \"192.168.0.7\", \"255.255.240.0\", \"192.168.0.3\");print(lan.ipconfig());", - "description": "Set the IP configuration method to automatic. Request the IP configuration. Example output:\n--- --lan.MODE_AUTO 134.63.78.136\u00a0\u00a0 255.255.254.0\u00a0\u00a0 134.63.78.1\n--- --Set the IP configuration method to manual. Request the IP configuration. Output:\n--- --lan.MODE_MANUAL 192.168.0.7\u00a0\u00a0\u00a0 255.255.240.0\u00a0 192.168.0.3\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.settime()", - "webhelpfile": "25726.htm", - "signature": "localnode.settime(year, month, day, hour, minute, second)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the date and time of the instrument.", - "details": "Internally, the instrument bases time in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).When called without a parameter (the first form), the function returns the current time.", - "param_info": [ - { - "name": "year", - "description": "Year; must be more than 1970", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "month", - "description": "Month (1 to 12)", - "enum": "", - "type": "number", - "range": "(1 to 12)" - }, - { - "name": "day", - "description": "Day (1 to 31)", - "enum": "", - "type": "number", - "range": "(1 to 31)" - }, - { - "name": "hour", - "description": "Hour in 24-hour time format (0 to 23)", - "enum": "", - "type": "number", - "range": "(0 to 23)" - }, - { - "name": "minute", - "description": "Minute (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - }, - { - "name": "second", - "description": "Second (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - } - ], - "usage": [ - "localnode.settime()", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "overloads": [ - "localnode.settime()", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "examples": [ - { - "example": "localnode.settime(2017, 12, 5, 15, 48, 20);print(localnode.settime());", - "description": "Sets the date and time to December 5, 2017 at 3:48:20\u00a0pm and verifies the time.\n--- --Output:\n--- --Tue Dec 5 15:48:20 2017\n" - }, - { - "example": "systemTime = os.time({year = 2018,; month = 3,; day = 31,; hour = 14,; min = 25});localnode.settime(systemTime);print(os.date('%c', gettime()));", - "description": "Sets the date and time to Mar 31, 2018 at 2:25\u00a0pm.\n--- --Output:\n--- --Sat Mar 31 14:25:00 2018\n" - } - ], - "related_commands": [ - "localnode.gettime()" - ] - }, - { - "name": "smu.interlock.tripped", - "webhelpfile": "25729.htm", - "signature": "", - "command_return": "interlockStatus", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates that the interlock has been tripped.", - "details": "This command gives you the status of the interlock. When the safety interlock signal is asserted, all voltage ranges of the instrument are available. However, when the safety interlock signal is not asserted, the 100\u00a0V range is hardware limited to a nominal output of less than \u00b142\u00a0V.When the interlock is not asserted:", - "param_info": [ - { - "name": "interlockStatus", - "description": "The status of the interlock", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlocktrippedinterlockStatus", - "range": "" - } - ], - "usage": [ - "interlockStatus = smu.interlock.tripped" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.interlock.tripped);", - "description": "If the interlock is not asserted, returns smu.OFF.\n--- --If the interlock is asserted, returns smu.ON.\n" - } - ], - "related_commands": [ - "smu.interlock.enable" - ] - }, - { - "name": "smu.measure.sense", - "webhelpfile": "25730.htm", - "signature": "", - "command_return": "sensing", - "type": "Attribute (RW)", - "default_value": "smu.SENSE_2WIRE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects local (2-wire) or remote (4-wire) sensing.", - "details": "This command determines if 2-wire (local) or 4-wire (remote) sensing is used.When you use 4-wire sensing, voltages are measured at the device under test (DUT). For the source voltage, if the sensed voltage is lower than the programmed amplitude, the voltage source increases the voltage until the sensed voltage is the same as the programmed amplitude. This compensates for IR drop in the output test leads.Using 4-wire sensing with voltage measurements eliminates any voltage drops that may be in the test leads between the Model 2460 and the DUT.When you are using 2-wire sensing, voltage is measured at the output connectors.When you are measuring resistance, you can enable 4-wire sensing to make 4-wire resistance measurements.When the output is off, 4-wire sensing is disabled and the instrument uses 2-wire sense, regardless of the sense setting. When the output is on, the selected sense setting is used.If the output is on when you change the sense setting, the output is turned off. ", - "param_info": [ - { - "name": "sensing", - "description": "Two-wire sensing", - "enum": "smu.SENSE_2WIRE nil|smu.SENSE_4WIRE nil", - "type": "smumeasuresensesensing", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuresensefunction", - "range": "" - } - ], - "usage": [ - "sensing = smu.measure.sense", - "smu.measure.sense = sensing", - "sensing = smu.measure.getattribute(function, ATTR_MEAS_SENSE)", - "smu.measure.setattribute(function, ATTR_MEAS_SENSE, sensing)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;", - "description": "Set the measurement function to resistance.\n--- --Set the sense to 4-wire remote.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.terminals", - "webhelpfile": "25737.htm", - "signature": "", - "command_return": "terminals", - "type": "Attribute (RW)", - "default_value": "smu.TERMINALS_FRONT\n", - "tsp_link": "Yes\n", - "description": "This attribute describes which set of input and output terminals the instrument is using.", - "details": "This command selects which set of input and output terminals the instrument uses. You can select front panel or rear panel terminals.If the output is on when you change from one set of terminals to the other, the output is turned off.This command replaces the smu.measure.terminals command, which is deprecated.", - "param_info": [ - { - "name": "terminals", - "description": "Use the front-panel input and output terminals", - "enum": "smu.TERMINALS_FRONT nil|smu.TERMINALS_REAR nil", - "type": "smuterminalsterminals", - "range": "" - } - ], - "usage": [ - "terminals = smu.terminals", - "smu.terminals = terminals" - ], - "overloads": [], - "examples": [ - { - "example": "smu.terminals = smu.TERMINALS_FRONT;", - "description": "Use the front-panel terminals for measurements.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.state()", - "webhelpfile": "25741.htm", - "signature": "trigger.model.state()", - "command_return": "status, status, n", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the present state of the trigger model.", - "details": "This command returns the state of the trigger model. The instrument checks the state of a started trigger model every 100\u00a0ms.This command returns the trigger state and the block that the trigger model last executed.The trigger model states are:", - "param_info": [ - { - "name": "status", - "description": "The status of the trigger model", - "enum": "trigger.STATE_ABORTED nil|trigger.STATE_ABORTING nil|trigger.STATE_BUILDING nil|trigger.STATE_EMPTY nil|trigger.STATE_FAILED nil|trigger.STATE_IDLE nil|trigger.STATE_RUNNING nil|trigger.STATE_WAITING nil", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "status", - "description": "The status of the parallel/dual trigger model", - "enum": "", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "n", - "description": "The last trigger model block that was executed", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status, status, n = trigger.model.state()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.state());", - "description": "An example output if the trigger model is waiting and is at block 9 would be:\n--- --trigger.STATE_WAITING trigger.STATE_EMPTY 9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "27637.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all events from the event log, including entries in the front-panel event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "eventlog.next()", - "eventlog.save()" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "27658.htm", - "signature": "eventlog.next(eventType)", - "command_return": "eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log.", - "details": "When an event occurs on the instrument, it is placed in the event log. The eventlog.next() command retrieves an unread event from the event log. Once an event is read, it can no longer be accessed remotely. However, it can be viewed on the front panel. When localnode.showevents is enabled, this command never returns an event because those events are automatically read and sent to the remote interface.To read multiple events, execute this command multiple times.If there are no entries in the event log, the following is returned:If the event type is not defined, an event of any type is returned.", - "param_info": [ - { - "name": "eventNumber", - "description": "The event number", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "message", - "description": "A description of the event", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity of the event", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "nodeID", - "description": "The TSP-Link node where the event occurred or 0 if the event occurred on the local node", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeSeconds", - "description": "The seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeNanoSeconds", - "description": "The fractional seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlognexteventType", - "range": "" - } - ], - "usage": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()", - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next(eventType)" - ], - "overloads": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()" - ], - "examples": [ - { - "example": "print(eventlog.next(5));", - "description": "Get the oldest error or information event from the event log.\n--- --Example output:\n--- ---285 TSP Syntax error at line 1: unexpected symbol near `0' 1 0 1367806152 652040060\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.getcount()", - "eventlog.save()" - ] - }, - { - "name": "file.read()", - "webhelpfile": "27929.htm", - "signature": "file.read(fileNumber, readAction)", - "command_return": "fileContents", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file on the USB flash drive.", - "details": "This command reads data from a file.", - "param_info": [ - { - "name": "fileContents", - "description": "The contents of the file based on the readAction parameter", - "enum": "", - "type": "string | nil", - "range": "" - }, - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to read", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "readAction", - "description": "The action", - "enum": "file.READ_LINE nil|file.READ_NUMBER nil|file.READ_ALL nil", - "type": "filereadreadAction", - "range": "" - } - ], - "usage": [ - "fileContents = file.read(fileNumber, readAction)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_READ);if file_num != nil then; file_contents = file.read(file_num, file.READ_ALL); file.close(file_num);end;", - "description": "Open testfile.txt on the USB flash drive for reading. If it opens successfully, read the entire contents of the file and store it in variable file_contents.\n--- --Close the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.close()", - "webhelpfile": "27930.htm", - "signature": "file.close(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes a file on the USB flash drive.", - "details": "Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to close", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.close(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/GENTRIGGER\", file.MODE_WRITE);file.close(file_num);", - "description": "Open the file GENTRIGGER for writing, then close it.\n" - } - ], - "related_commands": [ - "file.open()" - ] - }, - { - "name": "file.write()", - "webhelpfile": "27934.htm", - "signature": "file.write(fileNumber, string)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file on the USB flash drive.", - "details": "The file.write() function may include data that is buffering; it may not be written to the USB flash drive immediately. Use the file.flush() function to immediately write buffered data to the drive.You must use the file.close() command to close the file after writing.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to write", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "string", - "description": "A string that contains the data to write to the file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.write(fileNumber, string)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "file.close()", - "file.flush() " - ] - }, - { - "name": "file.flush()", - "webhelpfile": "27958.htm", - "signature": "file.flush(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffering data to a file on the USB flash drive.", - "details": "The file.write() function may be buffering data instead of writing immediately to the USB flash drive. Use file.flush() to flush this data. Data may be lost if the file is not closed or flushed before a script ends.If there is going to be a time delay before more data is written to a file, flush the file to prevent loss of data because of an aborted test.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to flush", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.flush(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();\u00a0;-- Fix the range to 10 V;smu.measure.range = 10;\u00a0;-- Set the measurement count to 100;smu.measure.count = 100;\u00a0;-- Set up reading buffers;-- Ensure the default measurement buffer size matches the count;defbuffer1.capacity = 100;smu.measure.read();\u00a0;testDir = \"TestData5\";\u00a0;-- create a directory on the USB drive for the data;file.mkdir(testDir);fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";buffer.save(defbuffer1, fileName);\u00a0;if file.usbdriveexists() != 0 then; -- testDir = \"TestData3\";\u00a0; -- Create a directory on the USB drive for the data; -- file.mkdir(testDir); -- Open the file where the data will be stored; -- fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\"; fileNumber = file.open(fileName, file.MODE_APPEND);-- Write header separator to file; file.write(fileNumber, \"\\n\\n====================================================================\\n\");-- Write the string data to a file; file.write(fileNumber, \"Tested to Company Standard ABC.123\\n\");-- Ensure a hurry-up of data written to the file before close or script end; file.flush(fileNumber);-- Close the data file; file.close(fileNumber);\u00a0;end;", - "description": "This example writes a string that indicates that the readings were made for a certain reason, such as to test to a company standard.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.output", - "webhelpfile": "28022.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "When the output is switched on, the instrument sources either voltage or current, as set by smu.source.func.", - "param_info": [ - { - "name": "sourceOutput", - "description": "Switch the source output off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceoutputsourceOutput", - "range": "" - } - ], - "usage": [ - "sourceOutput = smu.source.output", - "smu.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.output = smu.ON;", - "description": "Switch the source output of the instrument to on.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.offmode" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "28048.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "format.LITTLEENDIAN\n", - "tsp_link": "No\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.REAL32 and format.REAL64 data formats.If you are sending data to a computer with a Microsoft Windows operating system, select the format.LITTLEENDIAN byte order.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.BIGENDIAN nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "Output depends on the terminal program you use, but will look something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "28056.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "0 (Automatic)\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number from 1 to 16; set to 0 to have the instrument select the precision automatically based on the number that is being formatted", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.54000000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "28063.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "format.ASCII\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "You can control the precision of numeric values with the format.asciiprecision attribute. If format.REAL32 or format.REAL64 is selected, you can select the byte order with the format.byteorder attribute.The IEEE Std 754 binary formats use four bytes for single-precision values and eight bytes for double-precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCII nil|format.REAL32 nil|format.REAL64 nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "trigger.lanin[N].edge", - "webhelpfile": "28111.htm", - "signature": "", - "command_return": "edgeMode", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_EITHER\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.", - "param_info": [ - { - "name": "edgeMode", - "description": "The trigger mode; see the Details for more information", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "edgeMode = trigger.lanin[N].edge", - "trigger.lanin[N].edge = edgeMode" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[1].edge = trigger.EDGE_FALLING;", - "description": "Set the edge state of LAN event 1 to falling.\n" - } - ], - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "smu.measure.displaydigits", - "webhelpfile": "28416.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "smu.DIGITS_5_5\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the number of digits that are displayed for measurements on the front panel for the selected function.", - "details": "This command affects how the reading for a measurement is displayed on the front panel of the instrument. It does not affect the number of digits returned in a remote command reading. It also does not affect the accuracy or speed of measurements.The display digits setting is saved with the function setting, so if you use another function, then return to the function for which you set display digits, the display digits setting you set previously is retained.The change in digits occurs the next time a measurement is made.To change the number of digits returned in a remote command reading, use format.asciiprecision.", - "param_info": [ - { - "name": "digits", - "description": "6\u00bd display digits", - "enum": "smu.DIGITS_6_5 nil|smu.DIGITS_5_5 nil|smu.DIGITS_4_5 nil|smu.DIGITS_3_5 nil", - "type": "smumeasuredisplaydigitsdigits", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuredisplaydigitsfunction", - "range": "" - } - ], - "usage": [ - "digits = smu.measure.displaydigits", - "smu.measure.displaydigits = digits", - "digits = smu.measure.getattribute(function, ATTR_MEAS_DIGITS)", - "smu.measure.setattribute(function, ATTR_MEAS_DIGITS, digits)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.displaydigits = smu.DIGITS_6_5;", - "description": "Set the measurement function to voltage with a front-panel display resolution of 6\u00bd.\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "smu.measure.configlist.catalog()", - "webhelpfile": "28417.htm", - "signature": "smu.measure.configlist.catalog()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one measure configuration list that is stored on the instrument.", - "details": "You can use this command to retrieve the names of measure configuration lists that are stored in the instrument. This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no measure configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "output", - "description": "Returns the name of one measure configuration list that is stored on the instrument", - "enum": "", - "type": "string | nil", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.catalog());", - "description": "Request the name of one measure configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.query()", - "webhelpfile": "28418.htm", - "signature": "smu.measure.configlist.query(listName, index, fieldSeparator)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command recalls data for one configuration index.For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "output", - "description": "Returns a list of TSP commands and parameter settings that are stored in the specified configuration index", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.query(listName, index)", - "output = smu.measure.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "output = smu.measure.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(smu.measure.configlist.query(\"testMeasList\", 2, \"\\n\"));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n--- --Example output:\n--- --smu.measure.func = smu.FUNC_DC_CURRENT\n--- --smu.measure.range = 1.000000e-08\n--- --smu.measure.autorange = smu.ON\n--- --smu.measure.autorangelow = 1.000000e-08\n--- --smu.measure.autozero.enable = smu.ON\n--- --smu.measure.displaydigits = smu.DIGITS_5_5\n--- --smu.measure.filter.enable = smu.OFF\n--- --smu.measure.filter.count = 10\n--- --smu.measure.filter.type = smu.FILTER_REPEAT_AVG\n--- --smu.measure.limit[1].autoclear = smu.ON\n--- --smu.measure.limit[1].enable = smu.OFF\n--- --smu.measure.limit[1].high.value = 1.000000e+00\n--- --smu.measure.limit[1].low.value = -1.000000e+00\n--- --smu.measure.limit[2].autoclear = smu.ON\n--- --smu.measure.limit[2].enable = smu.OFF\n--- --smu.measure.limit[2].high.value = 1.000000e+00\n--- --smu.measure.limit[2].low.value = -1.000000e+00\n--- --smu.measure.math.enable = smu.OFF\n--- --smu.measure.math.format = smu.MATH_PERCENT\n--- --smu.measure.math.mxb.bfactor = 0.000000e+00\n--- --smu.measure.math.mxb.mfactor = 1.000000e+00\n--- --smu.measure.math.percent = 1.000000e+00\n--- --smu.measure.userdelay[1] = 0.000000e+00\n--- --smu.measure.userdelay[2] = 0.000000e+00\n--- --smu.measure.userdelay[3] = 0.000000e+00\n--- --smu.measure.userdelay[4] = 0.000000e+00\n--- --smu.measure.userdelay[5] = 0.000000e+00\n--- --smu.measure.nplc = 1.000000e+00\n--- --smu.measure.offsetcompensation = smu.OFF\n--- --smu.measure.sense = smu.SENSE_2WIRE\n--- --smu.terminals = smu.TERMINALS_FRONT\n--- --smu.measure.unit = smu.UNIT_AMP\n--- --smu.measure.rel.enable = smu.OFF\n--- --smu.measure.rel.level = 0.000000e+00\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.recall()", - "webhelpfile": "28419.htm", - "signature": "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a configuration index in a measure configuration list and an optional source configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a measure configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified measure configuration list. You can optionally specify a source configuration list and index to recall with the measure settings. If you do not specify a source index, the source index defaults to match the measure index. Specify a measure and source list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need the source and measure configuration lists coordinated, you can specify just the measure configuration list with this command and use the smu.source.configlist.recall() command to recall source settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, an error message is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. A single index stores the settings associated with a single measure function.This command recalls data for one configuration index from the specified measure configuration list and from the source configuration list (if specified).For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sourceListName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceIndex", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)", - "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)" - ], - "overloads": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.recall(\"MyMeasList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.measure.configlist.delete()", - "webhelpfile": "28421.htm", - "signature": "smu.measure.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a measure configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.delete(listName)", - "smu.measure.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.delete(\"myMeasList\");", - "description": "Delete a measure configuration list named myMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "lan.macaddress", - "webhelpfile": "28423.htm", - "signature": "", - "command_return": "MACaddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute describes the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets.", - "param_info": [ - { - "name": "MACaddress", - "description": "The MAC address of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "MACaddress = lan.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.macaddress);", - "description": "Returns the MAC address. For example:\n--- --08:00:11:00:00:57\n" - } - ], - "related_commands": [ - "lan.ipconfig()" - ] - }, - { - "name": "smu.measure.autozero.enable", - "webhelpfile": "29048.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "To ensure the accuracy of readings, the instrument must periodically get new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture that is being used for measurements. The Model 2460 uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made.The time to make the reference measurements is in addition to the normal measurement time. If timing is critical, such as in sweeps, you can disable autozero to avoid this time penalty.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "state", - "description": "The status of autozero; set to one of the following values", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautozeroenablestate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautozeroenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autozero.enable", - "smu.measure.autozero.enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_AUTO_ZERO)", - "smu.measure.setattribute(function, ATTR_MEAS_AUTO_ZERO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autozero.enable = smu.OFF;", - "description": "Set autozero off for voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.once()", - "smu.measure.nplc" - ] - }, - { - "name": "smu.measure.autozero.once()", - "webhelpfile": "29049.htm", - "signature": "smu.measure.autozero.once()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to refresh the reference and zero measurements once.", - "details": "This command forces a refresh of the reference and zero measurements that are used for the present aperture setting for the selected function.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "smu.measure.autozero.once()", - "description": "Do a one-time refresh of the reference and zero measurements.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.autozero.once()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.autozero.once();", - "description": "Do a one-time refresh of the reference and zero measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.enable" - ] - }, - { - "name": "smu.measure.nplc", - "webhelpfile": "29064.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the time that the input signal is measured for the selected function.", - "details": "This command sets the amount of time that the input signal is measured.The amount of time is specified as the number of power line cycles (NPLCs). Each PLC for 60\u00a0Hz is 16.67\u00a0ms (1/60) and each PLC for 50\u00a0Hz is 20\u00a0ms (1/50). For 60\u00a0Hz, if you set the NPLC to 0.1, the measure time is 1.667 ms.This command is set for the measurement of specific functions (current, resistance, or voltage).The shortest amount of time results in the fastest reading rate but increases the reading noise and decreases the number of usable digits.The longest amount of time provides the lowest reading noise and more usable digits but has the slowest reading rate.Settings between the fastest and slowest number of power line cycles are a compromise between speed and noise.If you change the PLCs, you may want to adjust the displayed digits to reflect the change in usable digits.", - "param_info": [ - { - "name": "nplc", - "description": "The number of power line cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurenplcfunction", - "range": "" - } - ], - "usage": [ - "nplc = smu.measure.nplc", - "smu.measure.nplc = nplc", - "nplc = smu.measure.getattribute(function, ATTR_MEAS_NPLC)", - "smu.measure.setattribute(function, ATTR_MEAS_NPLC, nplc)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.nplc = 0.5;", - "description": "Set the measurement function to DC Voltage.\n--- --Set the NPLC value to 0.5, which is 0.0083\u00a0seconds (0.5/60).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.protect.level", - "webhelpfile": "29072.htm", - "signature": "", - "command_return": "PROTECT_x", - "type": "Attribute (RW)", - "default_value": "smu.PROTECT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the overvoltage protection setting of the source output.", - "details": "Overvoltage protection restricts the maximum voltage level that the instrument can source. It is in effect when either current or voltage is sourced.This protection is in effect for both positive and negative output voltages.When this attribute is used in a test sequence, it should be set before turning the source on.", - "param_info": [ - { - "name": "PROTECT_x", - "description": "The overvoltage protection level, 2V, 5V, 10V, 20V, 40V, 60V, 80V, or NONEsmu.PROTECT_2Vsmu.PROTECT_5Vsmu.PROTECT_10Vsmu.PROTECT_20Vsmu.PROTECT_40Vsmu.PROTECT_60Vsmu.PROTECT_80Vsmu.PROTECT_NONE", - "enum": "smu.PROTECT_2V nil|smu.PROTECT_5V nil|smu.PROTECT_10V nil|smu.PROTECT_20V nil|smu.PROTECT_40V nil|smu.PROTECT_60V nil|smu.PROTECT_80V nil|smu.PROTECT_NONE nil", - "type": "smusourceprotectlevelPROTECT_x", - "range": "" - }, - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceprotectlevelsourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotectlevelfunction", - "range": "" - } - ], - "usage": [ - "PROTECT_x = smu.source.protect.level", - "smu.source.protect.level = PROTECT_x", - "PROTECT_x = smu.source.getattribute(function, ATTR_SRC_PROTECT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_PROTECT_LEVEL, PROTECT_x)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.protect.level = smu.PROTECT_40V;", - "description": "Sets the maximum voltage limit of the instrument to 40\u00a0V.\n" - } - ], - "related_commands": [ - "Overvoltage protection" - ] - }, - { - "name": "smu.source.delay", - "webhelpfile": "29079.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This command sets a delay for the selected source function. This delay is in addition to normal settling times.After the programmed source is turned on, this delay allows the source level to settle before a measurement is made.If you set a specific source delay (smu.source.delay), source autodelay is turned off.When source autodelay is turned on, the manual source delay setting is overwritten with the autodelay setting.When either a source delay or autodelay is set, the delay is applied to the first source output and then only when the magnitude of the source changes.", - "param_info": [ - { - "name": "sDelay", - "description": "The length of the delay (0 to 10 ks)", - "enum": "", - "type": "number", - "range": "(0 to 10 ks)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcedelayfunction", - "range": "" - } - ], - "usage": [ - "sDelay = smu.source.delay", - "smu.source.delay = sDelay", - "sDelay = smu.source.getattribute(function, ATTR_SRC_DELAY)", - "smu.source.setattribute(function, ATTR_SRC_DELAY, sDelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.delay = 3;", - "description": "Set the function to voltage. Set a 3 s delay after the source is turned on before a measurement is made.\n" - } - ], - "related_commands": [ - "smu.source.autodelay" - ] - }, - { - "name": "smu.measure.offsetcompensation", - "webhelpfile": "29137.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if offset compensation is used.", - "details": "This feature is only available for resistance measurements or when the smu.measure.unit is set to smu.UNIT_OHM.", - "param_info": [ - { - "name": "state", - "description": "Disable offset compensation", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureoffsetcompensationstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureoffsetcompensationfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.offsetcompensation", - "smu.measure.offsetcompensation = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_OFFSET_COMP)", - "smu.measure.setattribute(function, ATTR_MEAS_OFFSET_COMP, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;smu.measure.offsetcompensation = smu.ON;smu.source.output = smu.ON;print(smu.measure.read());smu.source.output = smu.OFF;", - "description": "Sets the measurement function to resistance. Set the instrument for 4-wire measurements and turn offset compensation on. Turn on the source, make a measurement, and turn the source off.\n--- --Example output:\n--- --81592000\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.offmode", - "webhelpfile": "29238.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "smu.OFFMODE_NORMAL\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the state of the source when the output is turned off.", - "details": "", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceoffmodesourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceoffmodefunction", - "range": "" - } - ], - "usage": [ - "sourceOffMode = smu.source.offmode", - "smu.source.offmode = sourceOffMode", - "sourceOffMode = smu.source.getattribute(function, ATTR_SRC_OFFMODE)", - "smu.source.setattribute(function, ATTR_SRC_OFFMODE, sourceOffMode)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.offmode = smu.OFFMODE_HIGHZ;", - "description": "Sets the output-off state so that the instrument opens the output relay when the output is turned off.\n" - } - ], - "related_commands": [ - "smu.source.output" - ] - }, - { - "name": "smu.source.func", - "webhelpfile": "29382.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_VOLTAGE\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "When you set this command, it configures the instrument as either a voltage source or a current source.When you read this command, it returns the output setting of the source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcefuncsFunction", - "range": "" - } - ], - "usage": [ - "sFunction = smu.source.func", - "smu.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;", - "description": "Sets the source function of the instrument to be a current source.\n" - } - ], - "related_commands": [ - "smu.source.level", - "smu.source.output" - ] - }, - { - "name": "smu.source.range", - "webhelpfile": "29383.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 1 \u00b5AVoltage: 200 mV\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the range for the source for the selected source function.", - "details": "This command manually selects the measurement range for the specified source.To select the range, specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 3\u00a0V, set the source level to 3. The Model 2460 selects the 20\u00a0V range.If you select a specific source range, the range must be large enough to source the value. If not, an overrange condition can occur.If an overrange condition occurs, an event is displayed and the change to the setting is ignored.The fixed current source ranges are 1\u00a0\u00b5A, 10\u00a0\u00b5A, 100\u00a0\u00b5A, 1\u00a0mA, 10\u00a0mA, 100\u00a0mA, 1\u00a0A, 4\u00a0A, 5\u00a0A, and 7\u00a0A.The fixed voltage source ranges are 200\u00a0mV, 2\u00a0V, 7\u00a0V, 10\u00a0V, 20\u00a0V, and 100\u00a0V.When you read this value, the instrument returns the positive full-scale value that the instrument is presently using.This command is intended to eliminate the time required by the automatic range selection.To select the range, you can specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 50\u00a0mV, send 0.05 (or 50e-3) to select the 200\u00a0mV range.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced; see Details for values; the ranges are", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.source.range", - "smu.source.range = rangeValue", - "rangeValue = smu.source.getattribute(function, ATTR_SRC_RANGE)", - "smu.source.setattribute(function, ATTR_SRC_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.OFF;smu.source.range = 1;", - "description": "Set the instrument to source current.\n--- --Turn autorange off.\n--- --Set the source range to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.autorange" - ] - }, - { - "name": "smu.source.autorange", - "webhelpfile": "29386.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the range is selected manually or automatically for the selected source function or voltage source.", - "details": "This command indicates the state of the range for the selected source. When automatic source range is disabled, the source range is set manually.When automatic source range is enabled, the instrument selects the range that is most appropriate for the value that is being sourced. The output level controls the range. If you read the range after the output level is set, the instrument returns the range that the instrument chose as appropriate for that source level.If the source range is set to a specific value from the front panel or a remote command, the setting for automatic range is set to disabled.Only available for the current and voltage functions.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautorangesourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautorangefunction", - "range": "" - } - ], - "usage": [ - "sourceAutorange = smu.source.autorange", - "smu.source.autorange = sourceAutorange", - "sourceAutorange = smu.source.getattribute(function, ATTR_SRC_RANGE_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_RANGE_AUTO, sourceAutorange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.ON;", - "description": "Set the source function to current.\n--- --Set the instrument to select the source range automatically.\n" - } - ], - "related_commands": [ - "smu.source.range" - ] - }, - { - "name": "smu.measure.autorange", - "webhelpfile": "29393.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the measurement range is set manually or automatically for the selected measure function.", - "details": "Autorange selects the best range in which to measure the signal that is applied to the input terminals of the instrument. When autorange is enabled, the range increases at 100 percent of range. The range decreases occur when the reading is <10\u00a0percent of nominal range.This command determines how the range is selected.When this command is set to off, you must set the range. If you do not set the range, the instrument remains at the range that was last selected by autorange.When this command is set to on, the instrument automatically goes to the most sensitive range to perform the measurement.", - "param_info": [ - { - "name": "autoRange", - "description": "Set the measurement range manually", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangeautoRange", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangefunction", - "range": "" - } - ], - "usage": [ - "autoRange = smu.measure.autorange", - "smu.measure.autorange = autoRange", - "autoRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_AUTO)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_AUTO, autoRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n" - } - ], - "related_commands": [ - "smu.measure.range" - ] - }, - { - "name": "smu.measure.range", - "webhelpfile": "29407.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 1 \u00b5AResistance: 200 M\u03a9Voltage: 2 V\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale measure range.", - "details": "You can assign any real number using this command. The instrument selects the closest fixed range that is large enough to measure the entered number. For example, for current measurements, if you expect a reading of approximately 9\u00a0mA, set the range to 9 mA to select the 10\u00a0mA range. When you read this setting, you see the positive full-scale value of the measurement range that the instrument is presently using.This command is primarily intended to eliminate the time that is required by the instrument to automatically search for a range.When a range is fixed, any signal greater than the entered range generates an overrange condition. When an overrange condition occurs, the front panel displays \"Overflow\" and the remote interface returns 9.9e+37.If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is the same as the source range, regardless of measurement range setting. However, the setting for the measure range is retained, and when the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.If you change the range while the output is off, the instrument does not update the hardware settings, but if you read the range setting, the return is the setting that will be used when the output is turned on. If you set a range while the output is on, the new setting takes effect immediately.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected value to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.measure.range", - "smu.measure.range = rangeValue", - "rangeValue = smu.measure.getattribute(function, ATTR_MEAS_RANGE)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 0.5;", - "description": "Set the source function to current.\n--- --Set the measurement function to voltage.\n--- --Instrument selects the 2 V measurement range.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangelow", - "webhelpfile": "29423.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 1 \u00b5AVoltage: 200 mVResistance: 2 \u03a9\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the lower limit for measurements of the selected function when the range is selected automatically.", - "details": "You can use this command when automatic range selection is enabled. It prevents the instrument from selecting a range that is below this limit. Because the lowest ranges generally require longer settling times, setting the low limit that is appropriate for your application but above the lowest possible range can make measurements require less settling time.The lower limit must be less than the upper limit.Though you can send any value when you send this command, the instrument selects the next highest range value. For example, if you send 15 for the lowest voltage range, the instrument will be set to the 20\u00a0V range as the low limit. If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "lowRange", - "description": "The lower limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangelowfunction", - "range": "" - } - ], - "usage": [ - "lowRange = smu.measure.autorangerangelow", - "smu.measure.autorangerangelow = lowRange", - "lowRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_LOW)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_LOW, lowRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;smu.measure.autorangelow = 2;", - "description": "Sets the low range for voltage measurements to 2\u00a0V.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangehigh", - "webhelpfile": "29432.htm", - "signature": "", - "command_return": "highRange", - "type": "AttributeResistance: (RW)Voltage and current: (R)", - "default_value": "Resistance: 200\u00a0M\u03a9\n", - "tsp_link": "Yes\n", - "description": "When autorange is selected, this attribute represents the highest measurement range that is used when the instrument selects the measurement range automatically.", - "details": "This command can be written to and read for resistance measurements. For current and voltage measurements, it can only be read.For current and voltage measurements, the upper limit is controlled by the current or voltage limit.For resistance measurements, you can use this command when automatic range selection is enabled to put an upper bound on the range that is used for resistance measurements.The upper limit must be more than the lower limit.If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "highRange", - "description": "The highest measurement range that is used when the range is set automatically", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangehighfunction", - "range": "" - } - ], - "usage": [ - "highRange = smu.measure.autorangehigh", - "smu.measure.autorangehigh = highRange", - "highRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_HIGH)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_HIGH, highRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;print(smu.measure.autorangehigh);", - "description": "Sets the measurement function to voltage and turn autorange on. Check the high range for voltage measurements.\n" - } - ], - "related_commands": [ - "reset()", - "smu.measure.autorange", - "smu.reset()" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "29636.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the instrument to provide an audible signal at a specific frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.Using this function from a remote interface does not affect audible errors or key click settings that were made from the Model 2460 front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the beep (20\u00a0Hz to 8000 Hz)", - "enum": "", - "type": "number", - "range": "(20\u00a0Hz to 8000 Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(2, 2400);", - "description": "Generates a 2 s, 2400\u00a0Hz tone.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "29846.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete (OPC) bit after all pending commands, including overlapped commands, have been executed.", - "details": "This function causes the operation complete bit in the Status Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "smu.measure.limit[Y].enable", - "webhelpfile": "29884.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables a limit test on the measurement from the selected measure function.", - "details": "This command enables or disables a limit test for the selected measurement function. When this attribute is enabled, the limit Y testing occurs on each measurement made by the instrument. Limit Y testing compares the measurements to the high-limit and low-limit values. If a measurement falls outside these limits, the test fails.", - "param_info": [ - { - "name": "state", - "description": "Disable the test", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitenablestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].enable", - "smu.measure.limit[Y].enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.limit[1].enable = smu.ON;", - "description": "Enable testing for limit 1 when measuring voltage.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].clear()", - "smu.measure.limit[Y].fail", - "smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].low.value" - ] - }, - { - "name": "smu.source.level", - "webhelpfile": "29907.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute immediately selects a fixed amplitude for the selected source function.", - "details": "This command sets the output level of the voltage or current source. If the output is on, the new level is sourced immediately.The sign of the source level dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.If a manual source range is selected, the level cannot exceed the specified range. For example, if the voltage source is on the 2\u00a0V range, you cannot set the voltage source level to 3\u00a0V. When autorange is selected, the amplitude can be set to any level supported by the instrument.", - "param_info": [ - { - "name": "sourceLevel", - "description": "Current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcelevelfunction", - "range": "" - } - ], - "usage": [ - "sourceLevel = smu.source.level", - "smu.source.level = sourceLevel", - "sourceLevel = smu.source.getattribute(function, ATTR_SRC_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LEVEL, sourceLevel)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 1;", - "description": "Set the instrument to source voltage and set it to source 1\u00a0V.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.output", - "smu.source.protect.level" - ] - }, - { - "name": "smu.measure.rel.enable", - "webhelpfile": "29986.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the application of a relative offset value to the measurement.", - "details": "When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value calculated when you acquire the relative offset value.Each returned measured relative reading is the result of the following calculation:", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurerelenablerelEnable", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerelenablefunction", - "range": "" - } - ], - "usage": [ - "relEnable = smu.measure.rel.enable", - "smu.measure.rel.enable = relEnable", - "relEnable = smu.measure.getattribute(function, ATTR_MEAS_REL_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_ENABLE, relEnable)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.rel.level", - "webhelpfile": "29987.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the relative offset value.", - "details": "This command specifies the relative offset value that can be applied to new measurements. When relative offset is enabled, all subsequent measured readings are offset by the value that is set for this\u00a0command.You can set this value, or have the instrument acquire a value. If the instrument acquires the value, read this setting to return the value that was measured\u00a0internally.", - "param_info": [ - { - "name": "relValue", - "description": "Relative offset value for measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerellevelfunction", - "range": "" - } - ], - "usage": [ - "relValue = smu.measure.rel.level", - "smu.measure.rel.level = relValue", - "relValue = smu.measure.getattribute(function, ATTR_MEAS_REL_LEVEL)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_LEVEL, relValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.rel.level = smu.measure.read();smu.measure.rel.enable = smu.ON;", - "description": "Sets the measurement function to current, performs a current measurement, uses it as the relative offset value, and enables the relative offset for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.enable" - ] - }, - { - "name": "smu.measure.filter.count", - "webhelpfile": "30064.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements that are averaged when filtering is enabled.", - "details": "The filter count is the number of readings that are acquired and stored in the filter stack for the averaging calculation. When the filter count is larger, more filtering is done, and the data is less noisy.This command is set for the selected function.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltercountfunction", - "range": "" - } - ], - "usage": [ - "filterCount = smu.measure.filter.count", - "smu.measure.filter.count = filterCount", - "filterCount = smu.measure.getattribute(function, ATTR_MEAS_FILTER_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_COUNT, filterCount)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.enable", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.filter.type", - "webhelpfile": "30065.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "smu.FILTER_REPEAT_AVG\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the type of averaging filter that is used for the selected measure function when the measurement filter is enabled.", - "details": "You can select one of two types of averaging filters: repeating average or moving average.When the repeating average filter is selected, a set of measurements are made. These measurements are stored in a measurement stack and averaged together to produce the averaged sample. Once the averaged sample is produced, the stack is flushed, and the next set of data is used to produce the next averaged sample. This type of filter is the slowest, since the stack must be completely filled before an averaged sample can be produced.When the moving average filter is selected, the measurements are added to the stack continuously on a first-in, first-out basis. As each measurement is made, the oldest measurement is removed from the stack. A new averaged sample is produced using the new measurement and the data that is now in the stack.The repeating average filter produces slower results but produces more stable results than the moving average filter. For either method, the greater the number of measurements that are averaged, the slower the averaged sample rate, but the lower the noise error. Trade-offs between speed and noise are normally required to tailor the instrumentation to your measurement application.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled; set to one of the following values", - "enum": "smu.FILTER_MOVING_AVG nil|smu.FILTER_REPEAT_AVG nil", - "type": "smumeasurefiltertypefilterType", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltertypefunction", - "range": "" - } - ], - "usage": [ - "filterType = smu.measure.filter.type", - "smu.measure.filter.type = filterType", - "filterType = smu.measure.getattribute(function, ATTR_MEAS_FILTER_TYPE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_TYPE, filterType)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.enable" - ] - }, - { - "name": "smu.measure.filter.enable", - "webhelpfile": "30066.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the averaging filter for the selected measurement function.", - "details": "This command enables or disables the averaging filter. When this is enabled, the reading returned by the instrument is an averaged value, taken from multiple measurements. The settings of the filter count and filter type for the selected measure function determines how the reading is averaged.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurefilterenablefilterState", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefilterenablefunction", - "range": "" - } - ], - "usage": [ - "filterState = smu.measure.filter.enable", - "smu.measure.filter.enable = filterState", - "filterState = smu.measure.getattribute(function, ATTR_MEAS_FILTER_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_ENABLE, filterState)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.math.mxb.bfactor", - "webhelpfile": "30107.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the offset, b, for the y = mx + b operation.", - "details": "This attribute specifies the offset (b) for an mx + b operation.The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation:Where:", - "param_info": [ - { - "name": "value", - "description": "The offset for the y = mx + b operation; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbbfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.bfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_BF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_BF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx +b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.mfactor" - ] - }, - { - "name": "smu.measure.math.mxb.mfactor", - "webhelpfile": "30108.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the scale factor, m, for the y = mx + b math operation.", - "details": "This command sets the scale factor (m) for an mx + b operation for the selected measurement function.The mx + b math operation lets you manipulate normal display readings (x) mathematically according to the following calculation:Where: ", - "param_info": [ - { - "name": "value", - "description": "The scale factor; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbmfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.mfactor", - "smu.measure.math.mxb.mfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_MF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_MF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx+b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor" - ] - }, - { - "name": "smu.measure.math.percent", - "webhelpfile": "30109.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the reference constant that is used when math operations are set to percent.", - "details": "This is the constant that is used when the math operation is set to percent for the selected measurement function.The percent math function displays measurements as percent deviation from a specified reference constant. The percent calculation is:Where:", - "param_info": [ - { - "name": "value", - "description": "The reference used when the math operation is set to percent; the range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathpercentfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.percent", - "smu.measure.math.percent = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_PERCENT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_PERCENT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.percent = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operations to percent.\n--- --Set the percentage value to 50 for voltage measurements.\n--- --Enable math operations.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.format" - ] - }, - { - "name": "smu.source.protect.tripped", - "webhelpfile": "30235.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the overvoltage source protection feature is active.", - "details": "When overvoltage protection is active, the instrument restricts the maximum voltage level that the instrument can source.", - "param_info": [ - { - "name": "value", - "description": "Overvoltage protection not active", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceprotecttrippedvalue", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotecttrippedfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.protect.tripped", - "value = smu.source.getattribute(function, ATTR_SRC_PROTECT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.protect.tripped);", - "description": "If overvoltage protection is active, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "Overvoltage protection", - "smu.source.protect.level" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "30485.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all readings and statistics from the specified buffer.", - "details": "", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);testData.clear();print(\"Readings in buffer after clear =\" .. testData.n);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);", - "description": "Create a reading buffer named testData, make three readings and store them in testData, and then view the readings.\n--- --Print number of readings in testData.\n--- --Output:\n--- ---4.5010112303956e-10, -3.9923108222095e-12, -4.5013931471161e-10\n--- --Clear the readings in testData.\n--- --Verify that there are no readings in testData.\n--- --Output:\n--- --Readings in buffer after clear = 0\n--- --Store three new readings in testData and view those when complete.\n--- --Output:\n--- --4.923509754e-07, 3.332266330e-07, 3.974883867e-07\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.dates", - "webhelpfile": "30488.htm", - "signature": "bufferVar.dates[N]", - "command_return": "date", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the dates of readings that are stored in the reading buffer.", - "details": "The dates are formatted as month, day, year.This is not available if the reading buffer style is set to compact.", - "param_info": [ - { - "name": "date", - "description": "The date of readings stored in bufferVar element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "date = bufferVar.dates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 1, testData);trigger.model.initiate();waitcomplete();print(testData.dates[1]);printbuffer(1, testData.n, testData.dates);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Example output:\n--- --11/27/2017\n--- --Prints the dates for readings 1 through the last reading in the buffer.\n--- --Example output:\n--- --11/27/2017, 11/27/2017, 11/27/2017\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "30489.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "User-defined buffer: buffer.FILL_ONCE (0)defbuffer1: buffer.FILL_CONTINUOUS (1)defbuffer2: buffer.FILL_CONTINUOUS (1)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if a reading buffer is filled continuously or is filled once and stops.", - "details": "When a reading buffer is set to fill once, no data is overwritten in the buffer. When the buffer is filled, no more data is stored in that buffer and new readings are discarded.When a reading buffer is set to fill continuously, the oldest data is overwritten by the newest data after the buffer fills.When you change the fill mode of a buffer, any data in the buffer is cleared.", - "param_info": [ - { - "name": "fillMode", - "description": "Fill the buffer, then stop", - "enum": "buffer.FILL_ONCE nil|buffer.FILL_CONTINUOUS nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);print(testData.fillmode);testData.fillmode = buffer.FILL_CONTINUOUS;print(testData.fillmode);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer. Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --0\n--- --Set fill mode to continuous. \n--- --Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.digout[N].stimulus", - "webhelpfile": "30501.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line.", - "details": "The digital trigger pulsewidth command determines how long the trigger is asserted.The trigger stimulus for a digital I/O line can be set to one of the trigger events that are described in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "event = trigger.digout[N].stimulus", - "trigger.digout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].stimulus = trigger.EVENT_TIMER3;", - "description": "Set the stimulus for output digital trigger line 2 to be the expiration of trigger timer 3.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()", - "trigger.digout[N].assert()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "30502.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the text from the front-panel USER swipe screen.", - "details": "", - "param_info": [ - { - "name": "display.clear()display.changescreen(display.SCREEN_USER_SWIPE)display.settext(display.TEXT1, \"Serial number:\")display.settext(display.TEXT2, localnode.serialno)", - "description": "Clear the USER swipe screen.Set the first line to read \"Serial number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"Serial number:\");display.settext(display.TEXT2, localnode.serialno);", - "description": "Clear the USER swipe screen.\n--- --Set the first line to read \"Serial number:\" and the second line to display the serial number of the instrument.\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "display.changescreen()", - "webhelpfile": "30503.htm", - "signature": "display.changescreen(screenName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function changes which front-panel screen is displayed.", - "details": "", - "param_info": [ - { - "name": "screenName", - "description": "The screen to display", - "enum": "display.SCREEN_HOME nil|display.SCREEN_HOME_LARGE_READING nil|display.SCREEN_READING_TABLE nil|display.SCREEN_GRAPH nil|display.SCREEN_HISTOGRAM nil|display.SCREEN_GRAPH_SWIPE nil|display.SCREEN_SETTINGS_SWIPE nil|display.SCREEN_SOURCE_SWIPE nil|display.SCREEN_STATS_SWIPE nil|display.SCREEN_USER_SWIPE nil|display.SCREEN_PROCESSING nil", - "type": "displaychangescreenscreenName", - "range": "" - } - ], - "usage": [ - "display.changescreen(screenName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT1, \"Batch A122\");display.settext(display.TEXT2, \"Test running\");display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clear the USER swipe screen.\n--- --Set the first line of the USER swipe screen to read \"Batch A122\" and the second line to display \"Test running\".\n--- --Display the USER swipe screen.\n--- --\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "localnode.showevents", - "webhelpfile": "30504.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (no events sent)\n", - "tsp_link": "No\n", - "description": "This attribute sets whether or not the instrument automatically outputs generated events to the remote interface.", - "details": "Enable this attribute to have the instrument output generated events to the remote interface.Events are output after a command message is executed but before prompts are issued (if prompts are enabled with localnode.prompts).If this attribute is disabled, use eventlog.next() to retrieve unread events from the event log.Events are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable show events when the GPIB connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "errorMode", - "description": "The errors that are returned", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "localnodeshoweventserrorMode", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showevents", - "localnode.showevents = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showevents = eventlog.SEV_ERROR | eventlog.SEV_INFO;trigger.digin[3].edge = trigger.EDGE_EITHER;", - "description": "Send generated error and warning messages.\n--- --Example output if the edge cannot be sent to either:\n--- --1805, Settings conflict: setting input edge when line 3 set for digital\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "localnode.prompts" - ] - }, - { - "name": "smu.measure.count", - "webhelpfile": "30505.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements to make when a measurement is requested.", - "details": "This command sets the number of measurements that are made when a measurement is requested. This command does not affect the trigger model.When smu.measure.count or if the function for smu.measure.setattribute is the active function, this command sets the count for all measure functions. When you send smu.measure.setattribute for a function that is not active, only the count for the specified function is changed.If you set the count to a value that is larger than the capacity of the reading buffer and the buffer fill mode is set to continuous, the buffer wraps until the number of readings specified have occurred. The earliest readings in the count are overwritten. If the buffer is set to fill once, readings stop when the buffer is filled, even if the count is not complete.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements (1 to 300,000 or buffer capacity)", - "enum": "", - "type": "integer", - "range": "(1 to 300,000 or buffer capacity)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurecountfunction", - "range": "" - } - ], - "usage": [ - "count = smu.measure.count", - "smu.measure.count = count", - "count = smu.measure.getattribute(function, ATTR_MEAS_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_COUNT, count)" - ], - "overloads": [], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1;smu.measure.count = 200; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;smu.measure.read(defbuffer1);\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses smu.measure.count to do a capacitor test. This outputs 200 readings that are similar to the following output:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - }, - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example demonstrates how to use the SimpleLoop trigger-model template instead of smu.measure.count to do a capacitor test. Similar to Example 1, this also outputs 200 readings that are similar to the following:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "smu.measure.read()", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.reset()", - "webhelpfile": "30521.htm", - "signature": "smu.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smu. to their default settings.", - "details": "This function turns off the output and resets the commands that begin with smu. to their default settings. It also deletes source and measure configuration lists.", - "param_info": [ - { - "name": "smu.reset()", - "description": "Turns off the output and resets the SMU commands to their default settings.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.reset();", - "description": "Turns off the output and resets the SMU commands to their default settings.\n" - } - ], - "related_commands": [ - "reset()" - ] - }, - { - "name": "status.operation.getmap()", - "webhelpfile": "30523.htm", - "signature": "status.operation.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Operation Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "setEvent, clearEvent = status.operation.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.getmap(0));", - "description": "Query bit 0 of the Operation Event Register.\n--- --Example output:\n--- --4918 4917\n" - } - ], - "related_commands": [ - "Operation Event Register", - "Programmable status register sets", - "status.operation.setmap()" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "30524.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Event Register.", - "details": "This query reads the contents of the questionable status event register. After sending this command and addressing the instrument to talk, a value is sent to the computer. This value indicates which bits in the appropriate register are set.The Questionable Register can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set the Questionable Register to the sum of their decimal weights. For example, to set bits B12 and B13, set the Questionable Register to 12,288 (which is the sum of 4,096\u00a0+\u00a08,192).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the questionable status register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.event" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 66 = binary 0100 0010;questionableRegister = 66;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B1 and B6 of the status questionable enable register.\n" - }, - { - "example": "-- decimal 2560 = binary 00001010 0000 0000;questionableRegister = 2560;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B9 and B11 of the status questionable enable register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "30525.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or sets the bits in the Status Enable register of the Standard Event Register.", - "details": "When a bit in the Status Enable register is set on and the corresponding bit in the Standard Event Status register is set on, the ESB bit of the Status Byte Register is set to on.To set a bit on, send the constant or value of the bit as the standardRegister parameter.You can set the bit as a constant or a numeric value, as shown in the table below. To set more than one bit of the register, you can send multiple constants with + between them. You can also set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B2, set standardRegister to 5 (which is the sum of 1 + 4). You can also send:status.standard.enable = status.standard.OPC + status.standard.QYEWhen zero (0) is returned, no bits are set. You can also send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The value of the Status Enable register of the Standard Event Register (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "standardRegister = status.standard.enable", - "status.standard.enable = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.QYE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and QYE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 5 = binary 0000 0101;standardRegister = 5;status.standard.enable = standardRegister;", - "description": "Uses a decimal value to set the OPC and QYE bits of the standard event status enable register.\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "trigger.timer[N].start.generate", - "webhelpfile": "30536.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies when timer events are generated.", - "details": "When this is set to on, a trigger event is generated immediately when the timer is triggered.When it is set to off, a trigger event is generated when the timer elapses. This generates the event trigger.EVENT_TIMERN.", - "param_info": [ - { - "name": "state", - "description": "Generate a timer event when the timer delay elapses", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerstartgeneratestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.generate", - "trigger.timer[N].start.generate = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;", - "description": "Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "bufferVar.sourceformattedvalues", - "webhelpfile": "30538.htm", - "signature": "bufferVar.sourceformattedvalues[N]", - "command_return": "values", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels formatted as they appear on the front-panel display when the readings in the reading buffer were acquired.", - "details": "The attribute is an array (a Lua table) of the sourced value that was in effect at the time of the reading. The source levels are formatted the same way the readings are formatted when they appear on the front-panel display.", - "param_info": [ - { - "name": "values", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "values = bufferVar.sourceformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 6, 0);trigger.model.initiate();waitcomplete();print(defbuffer1.sourceformattedvalues[1]);printbuffer(1,6,defbuffer1.sourceformattedvalues);", - "description": "Example output:\n--- ---00.00041 mV\n--- --Example output:\n--- ---00.00041 mV, +00.00010 mV, -00.00033 mV, +00.00003 mV, -00.00028 mV, -00.00045 mV\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fractionalseconds", - "webhelpfile": "30542.htm", - "signature": "bufferVar.fractionalseconds[N]", - "command_return": "fractionalSec", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the fractional second portion of the timestamp of each reading in the reading buffer.", - "details": "This read-only attribute is an array of the fractional portion of the timestamp, in seconds, when each reading occurred. Seconds are shown as fractions.", - "param_info": [ - { - "name": "fractionalSec", - "description": "The fractional second portion of the timestamp to 1\u00a0ns resolution", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "fractionalSec = bufferVar.fractionalseconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();print(testData.fractionalseconds[1]);printbuffer(1, 6, testData.fractionalseconds);", - "description": "Create a reading buffer named testData and make six measurements.\n--- --Print the fractional portion of the timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0.647118937\n--- --Print the fractional portion of the timestamp for the first six readings in the buffer.\n--- --Example output:\n--- --0.647118937, 0.064543, 0.48196127, 0.89938724, 0.316800064, 0.734218263\n" - } - ], - "related_commands": [ - "bufferVar.seconds", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "30545.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();for x = 1, 3 do printbuffer(x, x, testData.readings, testData.sourcevalues, testData.relativetimestamps) end;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the three readings in testData, including the measurement, source value, and relative timestamp.\n--- --Output:\n--- ---9.6420389034124e-12, 2, 0\n--- ---4.5509945811872e-10, 2, 0.277194856\n--- ---9.1078204006445e-12, 2, 0.569614783\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "30550.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourceValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "This attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.The values returned by this command depend on the source readback state:", - "param_info": [ - { - "name": "sourceValue", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "sourceValue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.func = smu.FUNC_DC_CURRENT;smu.source.level = 1e-6;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 3, testData.sourcevalues);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source value to 1e-6\u00a0A.\n--- --Print the source values being output when readings in the reading buffer were acquired. \n--- --Example output:\n--- --9.9999874692e-07, 1.0000017028e-06, 1.0000054544e-06\n" - } - ], - "related_commands": [ - "bufferVar.sourcestatuses", - "bufferVar.sourceunits", - "bufferVar.statuses", - "bufferVar.formattedreadings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()", - "smu.source.readback" - ] - }, - { - "name": "tsplink.initialize()", - "webhelpfile": "30551.htm", - "signature": "tsplink.initialize(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes all instruments and enclosures in the TSP-Link system.", - "details": "If the only node on the TSP-Link network is the one running the command and expectedNodes is not provided, this function generates an error event. If you set expectedNodes to 1, the node is initialized.If you include expectedNodes, if nodesFound is less than expectedNodes, an error event is generated.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes found on the system, including the node on which the command is running", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 32)", - "enum": "", - "type": "integer", - "range": "(1 to 32)" - } - ], - "usage": [ - "nodesFound = tsplink.initialize()", - "nodesFound = tsplink.initialize(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.initialize()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.initialize(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link initialization and indicate how many nodes are found.\n--- --Example output if two nodes are found:Nodes found = 2\n--- --Example output if fewer nodes are found and if localnode.showevents = 7:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "related_commands": [ - "Initializing the TSP-Link system", - "localnode.showevents", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "eventlog.getcount()", - "webhelpfile": "30552.htm", - "signature": "eventlog.getcount(eventType)", - "command_return": "count", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of unread events in the event log.", - "details": "A count finds the number of unread events in the event log. You can specify the event types to return or return the count for all events.This command reports the number of events that have occurred since the command was last sent or since the event log was last cleared.Events are read automatically when localnode.showevents is enabled. You can also read them individually with eventlog.next().", - "param_info": [ - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventloggetcounteventType", - "range": "" - }, - { - "name": "count", - "description": "A count finds the number of unread events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = eventlog.getcount()", - "count = eventlog.getcount(eventType)" - ], - "overloads": [ - "count = eventlog.getcount()" - ], - "examples": [ - { - "example": "print(eventlog.getcount(eventlog.SEV_INFO));", - "description": "Displays the present number of unread information messages in the instrument event log.\n--- --If there are three information messages in the event log, output is:\n--- --3\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.next()", - "localnode.showevents" - ] - }, - { - "name": "trigger.timer[N].start.overrun", - "webhelpfile": "30553.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.", - "param_info": [ - { - "name": "state", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].start.overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].start.stimulus", - "webhelpfile": "30555.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the event that starts the trigger timer.", - "details": "Set the stimulus to any trigger event to start the timer when that event occurs.Set the stimulus to none to disable event processing and use the timer as a timer or alarm based on the start time.Trigger events are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event that starts the trigger timer; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.timer[N].start.stimulus", - "trigger.timer[N].start.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;trigger.timer[1].delay = 3e-3;trigger.timer[1].start.stimulus = trigger.EVENT_DIGIO3;", - "description": "Set digital I/O line 3 to be a trigger input.\n--- --Set timer 1 to delay for 3\u00a0ms.\n--- --Set timer 1 to start the timer when an event is detected on digital I/O line 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.configlist.store()", - "webhelpfile": "30559.htm", - "signature": "smu.measure.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active measure settings into the named configuration list.", - "details": "Use this command to store the active measure settings to a configuration index in a configuration list. If the index parameter is not provided, the new settings are appended to the end of the list. The index only stores the active settings for a single active measure function.Configuration lists are not saved when the instrument is turned off or reset. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Refer to Settings stored in a measure configuration index for a complete list of measure settings that the instrument stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.store(listName)", - "smu.measure.configlist.store(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.store(\"MyConfigList\");", - "description": "Stores the active settings of the instrument to the end of the configuration list MyConfigList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.unit", - "webhelpfile": "30560.htm", - "signature": "", - "command_return": "unitOfMeasure", - "type": "Attribute (RW)", - "default_value": "Current: smu.UNIT_AMPResistance: smu.UNIT_OHMVoltage: smu.UNIT_VOLT\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.", - "details": "The change in measurement units is displayed when the next measurement is made.", - "param_info": [ - { - "name": "unitOfMeasure", - "description": "The units of measure to be displayed for the measurement", - "enum": "smu.UNIT_AMP nil|smu.UNIT_OHM nil|smu.UNIT_VOLT nil|smu.UNIT_WATT nil", - "type": "smumeasureunitunitOfMeasure", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureunitfunction", - "range": "" - } - ], - "usage": [ - "unitOfMeasure = smu.measure.unit", - "smu.measure.unit = unitOfMeasure", - "unitOfMeasure = smu.measure.getattribute(function, ATTR_MEAS_UNIT)", - "smu.measure.setattribute(function, ATTR_MEAS_UNIT, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.unit = smu.UNIT_WATT;", - "description": "Changes the front-panel display and buffer readings for voltage measurements to be displayed as power readings in watts.\n" - } - ], - "related_commands": [ - "smu.measure.func" - ] - }, - { - "name": "smu.source.ilimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 105\u00a0\u00b5ACurrent: 7.35 V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2460 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.ilimit.level", - "smu.source.ilimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.vlimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 105\u00a0\u00b5ACurrent: 7.35 V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2460 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.vlimit.level", - "smu.source.vlimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.ilimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.ilimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.vlimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.vlimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.sweeplinear()", - "webhelpfile": "30563.htm", - "signature": "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear sweep for a fixed number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears any existing trigger models, creates a source configuration list, and populates the trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10\u00a0ms for the source delay and 25\u00a0ms for the sweep delay, the actual delay is 35\u00a0ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. ", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50\u00a0\u00b5s to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearrangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplineardual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.source.sweeplinear(\"VoltLinSweep\", 0, 10, 20, 1e-3, 1, smu.RANGE_FIXED);smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set up a linear sweep that sweeps from 0 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLinSweep.\n--- --Set the measure function to current.\n--- --Set the current range to 100 \u03bcA.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "smu.source.sweeplinearstep()", - "webhelpfile": "30565.htm", - "signature": "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear source sweep configuration list and trigger model with a fixed number of steps.", - "details": "When the sweep is started, the instrument sources a specific voltage or current voltage to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it deletes the existing trigger model and creates a trigger model with a uniform series of ascending or descending voltage or current changes, called steps. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the stop level, which is calculated from the number of steps. A measurement is performed at each source step (including the start and stop levels). At this level, the instrument performs another measurement and then stops the sweep.The instrument uses the step size parameter to determine the number of source level changes. The source level changes in equal steps from the start level to the stop level. To avoid a setting conflicts error, make sure the step size is greater than the start value and less than the stop value. To calculate the number of source-measure points in a sweep, use the following formula: Points = [(Stop - Start) / Step] + 1When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "step", - "description": "The step size at which the source level will change; must be more than 0", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearstepsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearstepcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearsteprangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 1;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;smu.source.sweeplinearstep(\"CurrLogSweep\", -1.05, 1.05, .25, 10e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to current.\n--- --Set the source range to 1\u00a0A. Set the measure function to voltage with a range of 20\u00a0V.\n--- --Set up a linear step sweep that sweeps from -1.05\u00a0A to 1.05\u00a0A in 0.25\u00a0A increments with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep CurrLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.sweeplog()", - "webhelpfile": "30566.htm", - "signature": "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a logarithmic sweep for a set number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears the existing trigger model and creates a new trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. The asymptote changes the inflection of the sweep curve and allows it to sweep through zero. You can use the asymptote parameter to customize the inflection and offset of the source value curve. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep. The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplogsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplogcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplograngeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "asymptote", - "description": "Default is 0; see Details", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)" - ], - "overloads": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;smu.source.sweeplog(\"VoltLogSweep\", 1, 10, 20, 1e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set the measure function to current.\n--- --Set the current range to 100 uA.\n--- --Set up a log sweep that sweeps from 1 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.clear()", - "webhelpfile": "30567.htm", - "signature": "status.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears event registers.", - "details": "This command clears the event registers of the Questionable Event and Operation Event Register set. It does not affect the Questionable Event Enable or Operation Event Enable registers.", - "param_info": [ - { - "name": "status.clear()", - "description": "Clear the bits in the registers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "status.clear();", - "description": "Clear the bits in the registers\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.getblocklist()", - "webhelpfile": "30569.htm", - "signature": "trigger.model.getblocklist()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the settings for all trigger model blocks.", - "details": "This returns the settings for the trigger model.", - "param_info": [ - { - "name": "output", - "description": "Returns the settings for the trigger model", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getblocklist()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.getblocklist());", - "description": "Returns the settings for the trigger model. Example output is:\n--- -- 1) BUFFER_CLEAR BUFFER: defbuffer1\n--- -- 2) MEASURE BUFFER: defbuffer1 COUNT: 1\n--- -- 3) BRANCH_COUNTER VALUE: 5 BRANCH_BLOCK: 2\n--- -- 4) DELAY_CONSTANT DELAY: 1.000000000\n--- -- 5) BRANCH_COUNTER VALUE: 3 BRANCH_BLOCK: 2\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()" - ] - }, - { - "name": "trigger.model.getbranchcount()", - "webhelpfile": "30570.htm", - "signature": "trigger.model.getbranchcount(blockNumber)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the count value of the trigger model counter block.", - "details": "This command returns the counter value. When the counter is active, this returns the present count. If the trigger model has started or is running but has not yet reached the counter block, this value is 0.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "output", - "description": "Returns the count value of the trigger model counter block.", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getbranchcount(blockNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 0.1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);trigger.model.initiate();delay(1);print(trigger.model.getbranchcount(4));waitcomplete();", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and make five readings.\n--- --Delay 0.1 s.\n--- --Loop ten more times back to block 2.\n--- --Send the count command to check which count has been completed for block 4.\n--- --At end of execution, 10 readings are stored in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.initiate()", - "webhelpfile": "30571.htm", - "signature": "trigger.model.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function starts the trigger model.", - "details": "", - "param_info": [], - "usage": [ - "trigger.model.initiate()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.model.abort()" - ] - }, - { - "name": " trigger.BLOCK_BUFFER_CLEAR", - "webhelpfile": "30574.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that clears the reading buffer.", - "details": "When trigger model execution reaches the buffer clear trigger block, the instrument empties the specified reading buffer. The specified buffer can be the default buffer or a buffer that you defined.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_BUFFER_CLEAR, capTest2);", - "description": "Assign trigger block 3 to buffer clear; when the trigger model reaches block 3, it clears the reading buffer named capTest2.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Buffer clear block" - ] - }, - { - "name": "trigger.timer[N].enable", - "webhelpfile": "30576.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables the trigger timer.", - "details": "When this command is set to on, the timer performs the delay operation.When this command is set to off, there is no timer on the delay operation.You must enable a timer before it can use the delay settings or the alarm configuration. For expected results from the timer, it is best to disable the timer before changing a timer setting, such as delay or start seconds.To use the timer as a simple delay or pulse generator with digital I/O lines, make sure the timer start time in seconds and fractional seconds is configured for a time in the past. To use the timer as an alarm, configure the timer start time in seconds and fractional seconds for the desired alarm time.", - "param_info": [ - { - "name": "state", - "description": "Disable the trigger timer", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerenablestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].enable", - "trigger.timer[N].enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].enable = trigger.ON;", - "description": "Enable the trigger timer for timer 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.logstate", - "webhelpfile": "30577.htm", - "signature": "bufferVar.logstate", - "command_return": "logState", - "type": "Attribute (RW)", - "default_value": "defbuffer1: buffer.ON (1)defbuffer2: buffer.ON (1)User-created buffer: buffer.OFF (0)\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if information events are logged when the specified reading buffer is at 0% or 100% filled.", - "details": "If this is set to on, when the reading buffer is cleared (0% filled) or full (100% filled), an event is logged in the event log. If this is set to off, reading buffer status is not reported in the event log.", - "param_info": [ - { - "name": "logState", - "description": "Do not log information events", - "enum": "buffer.OFF nil|buffer.ON nil", - "type": "bufferVarlogstatelogState", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "logState = bufferVar.logstate", - "bufferVar.logstate = logState" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;MyBuffer = buffer.make(500);print(MyBuffer.logstate);", - "description": "Create the user-defined buffer MyBuffer.\n--- --Print the log state of MyBuffer.\n--- --Output:\n--- --0\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.readback", - "webhelpfile": "30579.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument records the measured source value or the configured source value when making a measurement.", - "details": "When source readback is off, the instrument records and displays the source value you set. When you use the actual source value (source readback on), the instrument measures the actual source value immediately before making the measurement of the device under test.Using source readback results in more accurate measurements, but also a reduction in measurement speed.When source readback is on, the front-panel display shows the measured source value and the buffer records the measured source value immediately before the device-under-test measurement. When source readback is off, the front-panel display shows the configured source value and the buffer records the configured source value immediately before the device-under-test measurement.", - "param_info": [ - { - "name": "state", - "description": "Disable readback", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcereadbackstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcereadbackfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.readback", - "smu.source.readback = state", - "state = smu.source.getattribute(function, ATTR_SRC_READBACK)", - "smu.source.setattribute(function, ATTR_SRC_READBACK, state)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testDataBuffer = buffer.make(100);smu.source.func = smu.FUNC_DC_VOLTAGE;smu.measure.func = smu.FUNC_DC_CURRENT;smu.source.readback = smu.ON;smu.source.level = 10;smu.measure.count = 100;smu.source.output = smu.ON;smu.measure.read(testDataBuffer);smu.source.output = smu.OFF;printbuffer(1, 100, testDataBuffer.sourcevalues, testDataBuffer);", - "description": "Reset the instrument to default settings.\n--- --Make a buffer named testDataBuffer that can hold 100 readings.\n--- --Set source function to voltage.\n--- --Set the measurement function to current.\n--- --Set read back on.\n--- --Set the instrument to take 100 readings.\n--- --Turn the output on.\n--- --Take the measurements.\n--- --Turn the output off.\n--- --Get the source values and measurements from the buffer.\n" - } - ], - "related_commands": [ - "smu.measure.func", - "smu.source.func" - ] - }, - { - "name": "smu.source.highc", - "webhelpfile": "30580.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When the instrument is measuring low current and is driving a capacitive load, you may see overshoot, ringing, and instability. You can enable the high capacitance mode to minimize these problems.", - "param_info": [ - { - "name": "state", - "description": "Turn high-capacitance mode off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcehighcstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcehighcfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.highc", - "smu.source.highc = state", - "state = smu.source.getattribute(function, ATTR_SRC_HIGHC)", - "smu.source.setattribute(function, ATTR_SRC_HIGHC, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.highc = smu.ON;", - "description": "Turn the high capacitance mode on.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - DurationLoop", - "webhelpfile": "30588.htm", - "signature": "trigger.model.load(DurationLoop, duration, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements for a specified amount of time.", - "details": "When you load this trigger-model template, you can specify amount of time to make a measurement and the length of the delay before the measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "DurationLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "duration", - "description": "The amount of time for which to make measurements (167 ns to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(167 ns to 100\u00a0ks)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)", - "trigger.model.load(DurationLoop, duration, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 5; ;-- Turn on output, initiate readings, and store them in defbuffer1;trigger.model.load(\"DurationLoop\", 10, 0.01, defbuffer1);trigger.model.initiate();", - "description": "Reset the instrument. Set the instrument to source voltage at 5\u00a0V. Set to measure current.\n--- --Load the duration loop trigger model to take measurements for 10 s with a 10\u00a0ms delay before each measurement.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "30981.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines.", - "details": "This function writes to the digital I/O port by setting the binary state of each digital line from an integer equivalent value.The binary representation of the value indicates the output pattern to be written to the I/O port. For example, a value of 63 has a binary equivalent of 111111 (all lines are set high); a data value of 42 has a binary equivalent of 101010 (lines 2, 4, and 6 are set high, and the other three lines are set low).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.You can also enter the data parameter as a binary value.", - "param_info": [ - { - "name": "data", - "description": "The value to write to the port (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(63);", - "description": "Sets digital I/O lines 1 through 6 high (binary 111111).\n" - }, - { - "example": "digio.writeport(0b111111);", - "description": "Sets digital I/O lines 1 through 6 high (digital\u00a063).\n" - } - ], - "related_commands": [ - "digio.readport()" - ] - }, - { - "name": "digio.line[N].state", - "webhelpfile": "30982.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low when the line is set for digital control and returns the state on the digital I/O lines.", - "details": "When a reset occurs, the digital line state can be read as high because the digital line is reset to a digital input. A digital input floats high if nothing is connected to the digital line.This returns the integer equivalent values of the binary states on all six digital I/O lines.Set the state to digio.STATE_LOW to clear the bit; set the state to digio.STATE_HIGH to set the bit.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "state", - "description": "Set the line low", - "enum": "digio.STATE_LOW nil|digio.STATE_HIGH nil", - "type": "digiolinestatestate", - "range": "" - } - ], - "usage": [ - "digio.line[N].state = state", - "state = digio.line[N].state" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_DIGITAL_OUT;digio.line[1].state = digio.STATE_HIGH;", - "description": "Sets line 1 (bit B1) of the digital I/O port high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.readport()", - "digio.writeport()", - "trigger.digin[N].edge" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "31076.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger timer settings to their default values.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their default values:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 to their default values.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].enable", - "trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.generate", - "trigger.timer[N].start.overrun", - "trigger.timer[N].start.seconds", - "trigger.timer[N].start.stimulus" - ] - }, - { - "name": " trigger.BLOCK_WAIT", - "webhelpfile": "31093.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that waits for an event before allowing the trigger model to continue.", - "details": "The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger block allows trigger execution to continue (see Details)", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "(see Details)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITclear", - "range": "" - }, - { - "name": "logic", - "description": "If each event must occur before the trigger model continues", - "enum": "trigger.WAIT_AND nil|trigger.WAIT_OR nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITlogic", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)" - ], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);", - "description": "Set trigger model block 9 to wait for a user to press the TRIGGER key on the front panel before continuing.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_MEASURE_DIGITIZE", - "webhelpfile": "31094.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that makes or digitizes a measurement.", - "details": "Digitized measurements are not a feature on the Model 2460. However, you can use this command to communicate with other Keithley instruments that do offer the digitized measurements feature and to share code with other Keithley instruments.Firmware versions of the Model 2460 before version 1.7.0 had a separate measure block. If you have code that is using that block, it works in this version of the Model 2460 firmware.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "count", - "description": "The number of measure or digitize readings to make before moving to the next block in the trigger model; set to", - "enum": "trigger.COUNT_INFINITE nil|trigger.COUNT_STOP nil|trigger.COUNT_AUTO nil", - "type": "triggermodelsetblocktriggerBLOCK_MEASURE_DIGITIZEcount", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set the function to measure DC voltage.\n--- --Set block 1 to clear defbuffer1.\n--- --Set block 2 to set a delay of 0.\n--- --Set block 3 to make measurements infinitely.\n--- --Set block 4 to wait until the front-panel TRIGGER key is pressed.\n--- --Set block 5 to stop making measurements.\n--- --Set block 6 to send a notification.\n--- --Start the trigger model.\n--- --You must press the front-panel TRIGGER key to stop measurements.\n--- --Output the number of readings.\n" - }, - { - "example": "reset();smu.measure.configlist.create(\"countactive\");smu.measure.count = 2;smu.measure.configlist.store(\"countactive\") -- index1;smu.measure.count = 10;smu.measure.configlist.store(\"countactive\") -- index2;smu.measure.count = 3;smu.measure.configlist.store(\"countactive\") -- index3;\u00a0;trigger.model.setblock(1, trigger.BLOCK_CONFIG_NEXT, \"countactive\");trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_AUTO);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 3, 1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set up a configuration list named countactive.\n--- --Set the measure count to 2 (replace smu.measure.count with smu.digitize.count if using a digitize function.)\n--- --Store the count in index 1.\n--- --Set the measure count to 10.\n--- --Store the count in index 2.\n--- --Set the measure count to 3.\n--- --Store the count in index 3.\n--- --Set up trigger model block 1 to call the next index from the countactive configuration list.\n--- --Set block 2 to measure or digitize and store the readings in defbuffer1, using the most recent count value.\n--- --Set block 3 to add a delay of 1\u00a0s.\n--- --Set block 4 to iterate through the trigger model 3 times, returning to block 1.\n--- --Start the trigger model.\n--- --Output the number of readings. There should be 15 readings.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Measure/Digitize block" - ] - }, - { - "name": " trigger.BLOCK_SOURCE_OUTPUT", - "webhelpfile": "31095.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that turns the output source on or off.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "Turn the source off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "triggermodelsetblocktriggerBLOCK_SOURCE_OUTPUTstate", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);", - "description": "Set trigger model to turn the source on when it reaches block 2.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_RECALL", - "webhelpfile": "31096.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the system settings that are stored in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.When the trigger model reaches a configuration recall block, the settings in the specified configuration list are recalled if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are recalled from the next index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.You can restore a specific set of configuration settings in the configuration list by defining the index.If you need to swap the source and measure configuration lists, you need to delete this block and create a new Config List Recall block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list to recall; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalIndex", - "description": "The index to recall from the second configuration list; defaults to 1", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5);", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5,; \"sourTrigList\") ;print(trigger.model.getblocklist());", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList and load index 1 from the configuration list name sourTrigList.\n--- --Query the configuration of the block.\n--- --Output:\n--- --5) CONFIG_RECALL CONFIG_LIST: measTrigList and sourTrigList INDEX: 5 and 1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_NEXT", - "webhelpfile": "31097.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the settings at the next index of a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "The name of the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");", - "description": "Configure trigger block 5 to load the next index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\");trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 1 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 1\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_NEXT CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the next index in both the configuration list named measTrigList and the configuration list named sourTrigList. \n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_PREV", - "webhelpfile": "31098.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.The Config List Prev block defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are each recalled from the previous index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.The configuration list previous index trigger block type recalls the previous index in a configuration list. It configures the source or measure settings of the instrument based on the settings at that index. The trigger model executes the settings at that index before the next block is executed.The first time the trigger model encounters this block, the last index in the configuration list is recalled if the list has not already had an index recalled by the recall block command in an earlier trigger model block. If the configuration list has recalled an index with the recall block, the previous index in the list is called instead of the last. For example, the recall block recalls index 1 by default, so if the trigger model uses a recall block before this one, the first time the previous block is reached after that recall, the last index is recalled. However, if the recall block recalled index 3, the previous block would recall index 2. Each subsequent time trigger model execution reaches a configuration list previous block for this configuration list, it goes backward one index. When the first index in the list is reached, it goes to the last index in the configuration list.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(8, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");", - "description": "Configure trigger block 8 to load the previous index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 3);trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 3 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Then, recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 3\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_PREV CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_PREV, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the previous index in both the configuration list named measTrigList and the configuration list named sourTrigList.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_DELAY_DYNAMIC", - "webhelpfile": "31101.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a user delay to the execution of the trigger model.", - "details": "Each measure function can have up to five unique user delay times (M1 to M5). Each source function can also have up to five unique user delay times (S1 to S5). The delay time is set by the user-delay command, which is only available over a remote interface. Though the trigger model can be used with any function, the user delay is set per function. Make sure you are setting the delay for the function you intend to use with the trigger model.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "userDelay", - "description": "The number of the user delay", - "enum": "trigger.USER_DELAY_M nil|trigger.USER_DELAY_S nil", - "type": "triggermodelsetblocktriggerBLOCK_DELAY_DYNAMICuserDelay", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "smu.measure.userdelay[N]", - "smu.source.userdelay[N]" - ] - }, - { - "name": " trigger.BLOCK_DIGITAL_IO", - "webhelpfile": "31102.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that sets the lines on the digital I/O port high or low.", - "details": "The bit mask defines the bits in the pattern that are driven high or low. A binary 1 in the bit mask indicates that the corresponding I/O line should be driven according to the bit pattern. To drive all lines, specify all ones (63, 0x3F, 0b111111) or omit this parameter. If the bit for a line in the bit pattern is set to 1, the line is driven high. If the bit is set to 0 in the bit pattern, the line is driven low.For this block to work as expected, make sure you configure the trigger type and line state of the digital line for use with the trigger model (use the digital line mode command).", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bitPattern", - "description": "Sets the value that specifies the output line bit pattern (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - }, - { - "name": "bitMask", - "description": "Specifies the bit mask; if omitted, all lines are driven (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)" - ], - "overloads": [], - "examples": [ - { - "example": "for x = 3, 6 do digio.line[x].mode = digio.MODE_DIGITAL_OUT end;trigger.model.setblock(4, trigger.BLOCK_DIGITAL_IO, 20, 60);", - "description": "The for loop configures digital I./O lines 3 through 6 as digital outputs. Trigger block 4 is then configured with a bit pattern of 20 (digital I/O lines 3 and 5 high). The optional bit mask is specified as 60 (lines 3 through 6), so both lines 3 and 5 are driven high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_COUNTER", - "webhelpfile": "31103.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that branches to a specified block a specified number of times.", - "details": "This command defines a trigger model building block that branches to another block using a counter to iterate a specified number of times.Counters increment every time the trigger model reaches them until they are more than or equal to the count value. At that point, the trigger model continues to the next building block in the sequence.The counter is reset to 0 when the trigger model starts. It is incremented each time trigger model execution reaches the counter block.If you are using remote commands, you can query the counter. The counter is incremented immediately before the branch compares the actual counter value to the set counter value. Therefore, the counter is at 0 until the first comparison. When the trigger model reaches the set counter value, branching stops and the counter value is one greater than the setting. Use trigger.model.getbranchcount() to query the counter.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetCount", - "description": "The number of times to repeat", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the counter is less than the targetCount value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);print(trigger.model.getbranchcount(4));", - "description": "When the trigger model reaches this block, the trigger model returns to block 2. This repeats 10 times.\n--- --An example of the return if the trigger model has reached this block 5 times is:\n--- --5\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_RESET_BRANCH_COUNT" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ON_EVENT", - "webhelpfile": "31104.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function branches to a specified block when a specified trigger event occurs.", - "details": "If you are using a timer, it must be started before it can expire. One method to start the timer in the trigger model is to include a Notify block before the On Event block. Set the Notify block to use the same timer as the On Event block.The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger model branches the specified block", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the specified event occurs", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ON_EVENT, trigger.EVENT_DISPLAY, 2);", - "description": "When the trigger model reaches this block, if the front-panel TRIGGER key has been pressed, the trigger model returns to block 2. If the TRIGGER key has not been pressed, the trigger model continues to block 7 (the next block in the trigger model).\n" - } - ], - "related_commands": [ - "On event block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_CONSTANT", - "webhelpfile": "31105.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if a measurement meets preset criteria.", - "details": "The type of limit can be:The measurement block must be a measure/digitize block that occurs in the trigger model before the branch-on-constant-limits block. The last measurement from a measure/digitize block is used.If the limit A is more than the limit B, the values are automatically swapped so that the lesser value is used as the lower limit.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitType", - "range": "" - }, - { - "name": "limitA", - "description": "The lower limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitA", - "range": "" - }, - { - "name": "limitB", - "description": "The upper limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitB", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the defined criteria", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, trigger.LIMIT_ABOVE, 0.1, 1, 2);", - "description": "Sets trigger block 5 to be a constant limit that branches to block 2 when the measurement is above the value set for limit B (which is set to 1). Note that limit A must be set but is ignored. \n" - } - ], - "related_commands": [ - "Constant Limit block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_DELTA", - "webhelpfile": "31107.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.", - "details": "This block calculates the difference between the last two measurements from a measure/digitize block. It subtracts the most recent measurement from the previous measurement.The difference between the measurements is compared to the target difference. If the difference is less than the target difference, the trigger model goes to the specified branching block. If the difference is more than the target difference, the trigger model proceeds to the next block in the trigger block sequence.If you do not define the measure/digitize block, it will compare measurements of a measure/digitize block that precedes the branch delta block. For example, if you have a measure/digitize block, a wait block, another measure/digitize block, another wait block, and then the branch delta block, the delta block compares the measurements from the second measure/digitize block. If a preceding measure/digitize block does not exist, an error occurs.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetDifference", - "description": "The value against which the block compares the difference between the measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the difference between the measurements is less than or equal to the targetDifference", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_DELTA, 0.35, 8, 3);", - "description": "Configure trigger block 5 to branch to block 8 when the measurement difference from block 3 is less than 0.35.\n" - } - ], - "related_commands": [ - "Delta block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE", - "webhelpfile": "31108.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.", - "details": "The branch-once building block branches to a specified block the first time trigger model execution encounters the branch-once block. If it is encountered again, the trigger model ignores the block and continues in the normal sequence.The once block is reset when trigger model execution reaches the idle state. Therefore, the branch-once block always executes the first time the trigger model execution encounters this block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model first encounters this block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE, 4);", - "description": "When the trigger model reaches block 2, the trigger model goes to block 4 instead of going in the default sequence of block 3.\n" - } - ], - "related_commands": [ - "Once block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE_EXCLUDED", - "webhelpfile": "31109.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.", - "details": "The branch-once-excluded block is ignored the first time the trigger model encounters it. After the first encounter, the trigger model goes to the specified branching block.The branch-once-excluded block is reset when the trigger model starts or is placed in idle.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model encounters this block after the first encounter", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, 4);", - "description": "When the trigger model reaches block 2 the first time, the trigger model goes to block 3. If the trigger model reaches this block again, the trigger model goes to block 4.\n" - } - ], - "related_commands": [ - "Once excluded block" - ] - }, - { - "name": " trigger.BLOCK_NOTIFY", - "webhelpfile": "31110.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that generates a trigger event and immediately continues to the next block.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "The identification number of the notification; 1 to 8", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.model.setblock(5, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY2);trigger.digout[3].stimulus = trigger.EVENT_NOTIFY2;", - "description": "Define trigger model block 5 to be the notify 2 event. Assign the notify 2 event to be the stimulus for digital output line 3.\n" - } - ], - "related_commands": [ - "Notify block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ALWAYS", - "webhelpfile": "31112.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that always goes to a specific block.", - "details": "When the trigger model reaches a branch-always building block, it goes to the building block set by branchToBlock.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number to execute when the trigger model reaches the Branch Always block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ALWAYS, 20);", - "description": "When the trigger model reaches block 6, always branch to block 20.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_DYNAMIC", - "webhelpfile": "31114.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.", - "details": "The measure/digitize block must occur in the trigger model before the branch-on-dynamic-limits block. If no block is defined, the measurement from the previous measure/digitize block is used. If no previous measure/digitize block exists, an error is reported.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_DYNAMIClimitType", - "range": "" - }, - { - "name": "limitNumber", - "description": "The limit number (1 or 2)", - "enum": "", - "type": "1|2", - "range": "(1 or 2)" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the criteria set in the configuration list", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, trigger.LIMIT_OUTSIDE, 2, 10, 5);", - "description": "Configure block 7 to check if limit 2 is outside its limit values, based on the measurements made in block 5. If values are outside the measurements, branch to block 10. If the values are not outside the measurements, trigger model execution continues to block 8.\n" - } - ], - "related_commands": [ - "Dynamic Limit block", - "smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].high.value" - ] - }, - { - "name": " trigger.BLOCK_DELAY_CONSTANT", - "webhelpfile": "31347.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a constant delay to the execution of a trigger model.", - "details": "When trigger model execution reaches a delay block, it stops normal measurement and trigger model operation for the time set by the delay. Background measurements continue to be made, and if any previously executed block started infinite measurements, they also continue to be made.If other delays have been set, this delay is in addition to the other delays.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "time", - "description": "The amount of time to delay in seconds (167 ns to 10 ks, or 0 for no delay)", - "enum": "", - "type": "number", - "range": "(167 ns to 10 ks, or 0 for no delay)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_DELAY_CONSTANT, 30e-3);", - "description": "Configure trigger block 7 to delay the trigger model before the next block until a delay of 30 ms elapses.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digin[N].edge", - "webhelpfile": "31360.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the edge used by the trigger event detector on the given trigger line.", - "details": "This command sets the logic on which the trigger event detector and the output trigger generator operate on the specified trigger line.To directly control the line state, set the mode of the line to digital and use the write command. When the digital line mode is set for open drain, the edge settings assert a TTL low-pulse.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger logic value", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggerdiginedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "detectedEdge = trigger.digin[N].edge", - "trigger.digin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;trigger.digin[4].edge = trigger.EDGE_RISING;", - "description": "Sets the trigger mode for digital I/O line\u00a04 to detect a rising-edge trigger as an input.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "digio.writeport()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "digio.line[N].mode", - "webhelpfile": "31363.htm", - "signature": "", - "command_return": "lineMode", - "type": "Attribute (RW)", - "default_value": "digio.MODE_DIGITAL_IN\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode of the digital I/O line to be a digital line, trigger line, or synchronous line and sets the line to be input, output, or open-drain.", - "details": "", - "param_info": [ - { - "name": "lineMode", - "description": "The digital line control type and line mode", - "enum": "digio.MODE_DIGITAL_IN nil|digio.MODE_DIGITAL_OUT nil|digio.MODE_DIGITAL_OPEN_DRAIN nil|digio.MODE_TRIGGER_IN nil|digio.MODE_TRIGGER_OUT nil|digio.MODE_TRIGGER_OPEN_DRAIN nil|digio.MODE_SYNCHRONOUS_MASTER nil|digio.MODE_SYNCHRONOUS_ACCEPTOR nil", - "type": "digiolinemodelineMode", - "range": "" - }, - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "lineMode = digio.line[N].mode", - "digio.line[N].mode = lineMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_TRIGGER_OUT;", - "description": "Set digital I/O line 1 to be an output trigger line.\n" - } - ], - "related_commands": [ - "trigger.digin[N].edge" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "31368.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the digital I/O port. The least significant bit (bit B1) of the binary number corresponds to digital I/O line 1; bit B6 corresponds to digital I/O line 6.For example, a returned value of 42 has a binary equivalent of 101010, which indicates that lines 2, 4, 6 are high (1), and the other lines are low (0).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, and 6 are set high when the I/O port is read.\n--- --Output:\n--- --42\n--- --This is binary 101010\n" - } - ], - "related_commands": [ - "digio.writeport()" - ] - }, - { - "name": "trigger.digin[N].clear()", - "webhelpfile": "31373.htm", - "signature": "trigger.digin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital input line.", - "details": "The event detector of a trigger enters the detected state when an event is detected. For the specified trigger line, this command clears the event detector, discards the history, and clears the overrun status(sets the overrun status to false).", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.digin[2].clear();", - "description": "Clears the trigger event detector on I/O line\u00a02.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digin[N].wait()" - ] - }, - { - "name": "trigger.digin[N].overrun", - "webhelpfile": "31378.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "overrun = trigger.digin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.digin[1].overrun;print(overrun);", - "description": "If there is no trigger overrun on digital input\u00a01, the output is:\n--- --false\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].pulsewidth", - "webhelpfile": "31385.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0us)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use trigger.digout[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "width = trigger.digout[N].pulsewidth", - "trigger.digout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digout[N].assert()", - "trigger.digout[N].release()" - ] - }, - { - "name": "trigger.digout[N].assert()", - "webhelpfile": "31392.htm", - "signature": "trigger.digout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines.", - "details": "Initiates a trigger event and does not wait for completion. The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].pulsewidth = 20e-6;trigger.digout[2].assert();", - "description": "Asserts a trigger on digital I/O line 2 with a pulse width of 20\u00a0us.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "digio.line[N].reset()", - "webhelpfile": "31393.htm", - "signature": "digio.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets digital I/O line values to their factory defaults.", - "details": "This function resets the following attributes to their default values:It also clears trigger.digin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "digio.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "-- Set the digital I/O trigger line 3 for a falling edge;digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.digout[3].logic = trigger.LOGIC_NEGATIVE;-- Set the digital I/O trigger line 3 to have a pulsewidth of 50 microseconds.;trigger.digout[3].pulsewidth = 50e-6;-- Use digital I/O line 5 to trigger the event on line 3.;trigger.digout[3].stimulus = trigger.EVENT_DIGIO5;-- Print configuration (before reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);-- Reset the line back to factory default values.;digio.line[3].reset();-- Print configuration (after reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);", - "description": "Output before reset:\n--- --digio.MODE_TRIGGER_OUT 5e-05 trigger.EVENT_DIGIO5\n--- --\u00a0\n--- --Output after reset:\n--- --digio.MODE_TRIGGER_IN 1e-05 trigger.EVENT_NONE\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digout[N].pulsewidth", - "trigger.digout[N].stimulus" - ] - }, - { - "name": "trigger.digin[N].wait()", - "webhelpfile": "31394.htm", - "signature": "trigger.digin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time trigger.digin[N].wait() or trigger.digin[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and is ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detected", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.digin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;triggered = trigger.digin[4].wait(3);print(triggered);", - "description": "Waits up to 3 s for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].release()", - "webhelpfile": "31395.htm", - "signature": "trigger.digout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].assert()", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "trigger.lanout[N].assert()", - "webhelpfile": "31396.htm", - "signature": "trigger.lanout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].assert();", - "description": "Creates a trigger with LAN trigger 5.\n" - } - ], - "related_commands": [ - "lan.lxidomain", - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].wait()", - "webhelpfile": "31397.htm", - "signature": "trigger.lanin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time trigger.lanin[N].wait() or trigger.lanin[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.lanin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.lanin[5].wait(3);", - "description": "Wait for a trigger event with LAN trigger 5 with a timeout of 3\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].clear()", - "webhelpfile": "31398.htm", - "signature": "trigger.lanin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[5].clear();", - "description": "Clears the event detector with LAN event trigger 5.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun" - ] - }, - { - "name": "trigger.lanout[N].connect()", - "webhelpfile": "31401.htm", - "signature": "trigger.lanout[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;trigger.lanout[1].connect();trigger.lanout[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].disconnect()", - "webhelpfile": "31404.htm", - "signature": "trigger.lanout[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger event generator.", - "details": "When this command is set for TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].disconnect()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].connected", - "webhelpfile": "31406.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN event connection state.", - "details": "This is set to true when the LAN trigger is connected and ready to send trigger events after a successful trigger.lanout[N].connect() command. If the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attribute is changed or when the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = trigger.lanout[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;print(trigger.lanout[1].connected);", - "description": "Outputs true if connected, or false if not connected.\n--- --Example output:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].ipaddress", - "webhelpfile": "31409.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted-decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.After you change this setting, you must send the connect command before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = trigger.lanout[N].ipaddress", - "trigger.lanout[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[3].protocol = lan.PROTOCOL_TCP;trigger.lanout[3].ipaddress = \"192.0.32.10\";trigger.lanout[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be TCP when sending LAN triggers.\n--- --Use IP address \"192.0.32.10\" to connect the LAN trigger.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()" - ] - }, - { - "name": "trigger.lanin[N].overrun", - "webhelpfile": "31413.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.lanin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.lanin[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].protocol", - "webhelpfile": "31416.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "lan.PROTOCOL_TCP\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all the supported protocols. However, it uses the designated protocol for sending outgoing messages.After you change this setting, you must re-connect the LAN trigger event generator before you can send outgoing event messages.When multicast is selected, the trigger IP address is ignored, and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.PROTOCOL_TCP nil|lan.PROTOCOL_UDP nil|lan.PROTOCOL_MULTICAST nil", - "type": "triggerlanoutprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = trigger.lanout[N].protocol", - "trigger.lanout[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.lanout[1].protocol);", - "description": "Get LAN protocol that is being used for sending trigger messages for LAN event 1.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "trigger.lanout[N].stimulus", - "webhelpfile": "31419.htm", - "signature": "", - "command_return": "LANevent", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set the event to one of the existing trigger events, which are shown in the following table.Setting this attribute to none disables automatic trigger generation.If any events are detected before the trigger LAN connection is sent, the event is ignored, and the action overrun is set.", - "param_info": [ - { - "name": "LANevent", - "description": "The LAN event that causes this trigger to assert; see Details for values", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "LANevent = trigger.lanout[N].stimulus", - "trigger.lanout[N].stimulus = LANevent" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].stimulus = trigger.EVENT_TIMER1;", - "description": "Use the timer 1 trigger event as the source for LAN trigger 5 stimulus.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "smu.measure.userdelay[N]", - "webhelpfile": "31441.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay (0 for no delay, or 167\u00a0ns to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 for no delay, or 167\u00a0ns to 10 ks)" - }, - { - "name": "N", - "description": "The user delay to which this time applies (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The measurement function; see Functions", - "enum": "", - "type": "smumeasureuserdelayfunction", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.measure.userdelay[N]", - "smu.measure.userdelay[N] = delayTime", - "delayTime = smu.measure.getattribute(function, ATTR_MEAS_USER_DELAY_N)", - "smu.measure.setattribute(function, ATTR_MEAS_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "smu.measure.readwithtime()", - "webhelpfile": "31457.htm", - "signature": "smu.measure.readwithtime()", - "command_return": "reading, seconds, fractional", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates measurements and returns the last actual measurement and time information in UTC format without using the trigger model.", - "details": "This command initiates measurements using the present function setting, stores the readings in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "seconds", - "description": "Seconds in UTC format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractional", - "description": "Fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading, seconds, fractional = smu.measure.readwithtime()", - "smu.measure.readwithtime(bufferName)" - ], - "overloads": [ - "smu.measure.readwithtime(bufferName)" - ], - "examples": [ - { - "example": "print(smu.measure.readwithtime(defbuffer1));", - "description": "Print the last measurement and time information from defbuffer1 in UTC format, which will look similar to:\n--- ---1.405293589829e-11 1400904629 0.1950935\n" - } - ], - "related_commands": [ - "smu.measure.count", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.source.sweeplist()", - "webhelpfile": "31499.htm", - "signature": "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a sweep based on a configuration list, which allows you to customize the sweep.", - "details": "This command allows you to set up a custom sweep, using a configuration list to specify the source levels.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.To run the sweep, initiate the trigger model.You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list where the sweep starts; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is 0 for no delay or you can set a specific delay value from 50 us to 10 ks", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplistcount | integer", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplistfailAbort", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)" - ], - "overloads": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"CurrListSweep\");smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 100e-3;smu.source.level = 1e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 10e-6;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 7e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 11e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 9e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.sweeplist(\"CurrListSweep\", 1, 0.001);smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;trigger.model.initiate();", - "description": "Reset the instrument to its defaults\n--- --Create a source configuration list called CurrListSweep.\n--- --Set the source function to current.\n--- --Set the source current range to 100\u00a0mA.\n--- --Set the source current level to 1\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 10\u00a0uA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 7\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 11\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 9\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set up a list sweep that uses the entries from the CurrListSweep configuration list and starts at index 1 of the list.\n--- --Set a source delay of 1\u00a0ms.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.questionable.setmap()", - "webhelpfile": "31612.htm", - "signature": "status.questionable.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function maps events to bits in the questionable event registers.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.questionable.setmap(bitNumber, setEvent)", - "status.questionable.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.questionable.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.questionable.setmap(0, 4917, 4918);", - "description": "When event 4917 (a default buffer is 0% filled) occurs, bit 0 is set in the condition register and the event register of the Questionable Event Register. When event 4918 (a default buffer is 100% filled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "status.questionable.getmap()" - ] - }, - { - "name": "status.questionable.getmap()", - "webhelpfile": "31613.htm", - "signature": "status.questionable.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Questionable Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - } - ], - "usage": [ - "setEvent, clearEvent = status.questionable.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.getmap(9));", - "description": "Returns the events that were mapped to set and clear bit 9.\n" - } - ], - "related_commands": [ - "Questionable Event Register", - "status.questionable.setmap()" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "31614.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Condition Register of the status model.", - "details": "This command reads the contents of the Questionable Condition Register, which is one of the Questionable Event Registers.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.condition);", - "description": "Reads the Questionable Condition Register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "31615.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the questionable event enable register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Questionable Event Register.When one of these bits is set, when the corresponding bit in the Questionable Event Register or Questionable Condition Register is set, the MSB and QSM bits in the Status Byte Register are set.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.enable", - "status.questionable.enable = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = 17;print(status.questionable.enable);", - "description": "Set bits 0 and 4 of the Questionable Event Enable Register.\n--- --Returns 17, which indicates the register was set correctly.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.condition", - "webhelpfile": "31635.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "You can use this command to read the status byte, which is returned as a numeric value. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence. The returned value can indicate that one or more status events occurred. If more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).The meanings of the individual bits of this register are shown in the following table.", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Example output:\n--- --1.2900000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "31637.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the Operation Event Enable Register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Operation Event Register.When one of these bits is set, when the corresponding bit in the Operation Event Register or Operation Condition Register is set, the OSB bit in the Status Byte Register is set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.enable", - "status.operation.enable = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Sets the 12 and 14 bits of the operation status enable register using a decimal value.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "31638.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This attribute reads the operation event register of the status model.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.event" - ], - "overloads": [], - "examples": [ - { - "example": "status.request_enable = status.OSB ;status.operation.setmap(0, 4918, 4917);status.operation.enable = 1;defbuffer1.clear();defbuffer1.fillmode = buffer.FILL_ONCE;defbuffer1.capacity = 10;smu.measure.count = 10;smu.measure.read();print(status.operation.event);", - "description": "Set bits in the Status Request Enable Register to record an enabled event in the Operation Status Register.\n--- --Map event number 4918 (a default buffer is full) to set bit 0 in the Operation Event Register and event number 4917 (a default buffer is empty) to clear bit 0.\n--- --Clear defbuffer1.\n--- --Set defbuffer1 to fill once.\n--- --Resizes defbuffer1 to 10 readings. \n--- --Sets the measure count to 10 readings and makes a measurement. \n--- --Reads the operation event register.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "31639.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This command reads the contents of the Operation Condition Register, which is one of the Operation Event Registers.For detail on interpreting the value of a register, see Understanding bit settings.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.condition);", - "description": "Returns the contents of the register.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.setmap()", - "webhelpfile": "31648.htm", - "signature": "status.operation.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to map events to bits in the Operation Event Register.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.operation.setmap(bitNumber, setEvent)", - "status.operation.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.operation.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.operation.setmap(0, 2731, 2732);", - "description": "When event 2731 (trigger model initiated) occurs, bit 0 in the condition and event registers of the Operation Event Register are set. When event 2732 (trigger model idled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "Operation Event Register", - "Programmable status register sets", - "status.operation.getmap()" - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "31653.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the contents of the Standard Event Status Register set of the status model.", - "details": "When this command returns zero (0), no bits are set. You can send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "standardRegister = status.standard.event" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.standard.event);", - "description": "May return the value 129, showing that the Standard Event Status Register contains binary 10000001\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "32386.htm", - "signature": "", - "command_return": "SRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the settings of the Service Request (SRQ) Enable Register.", - "details": "This command sets or clears the individual bits of the Status Request Enable Register.The Status Request Enable Register is cleared when power is cycled or when a parameter value of 0 is sent with this command.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "SRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings (0 to 255)", - "enum": "", - "type": "integer", - "range": "(SRQ)" - } - ], - "usage": [ - "SRQEnableRegister = status.request_enable", - "status.request_enable = SRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register and clear all other bits.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits and clear all other bits of the service request (SRQ) enable register.\n" - }, - { - "example": "status.request_enable = 0;", - "description": "Clear the register.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.gettime()", - "webhelpfile": "32416.htm", - "signature": "localnode.gettime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the instrument date and time.", - "details": "The time is returned in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "print(os.date('%c', gettime()))", - "description": "Example output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "print(os.date('%c', gettime()));", - "description": "Example output:\n--- --Tue Dec 5 03:44:37 2017\n" - } - ], - "related_commands": [ - "localnode.settime()" - ] - }, - { - "name": "tsplink.line[N].mode", - "webhelpfile": "32538.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "tsplink.MODE_DIGITAL_OPEN_DRAIN\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation of a TSP-Link line.", - "details": "This command defines whether or not the line is used as a digital or trigger control line and if it is an input or output.The line mode can be set to the following options:", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode; see Details", - "enum": "", - "type": "tsplinkLineMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.line[N].mode", - "tsplink.line[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;", - "description": "Sets the trigger mode for synchronization line 3 as a trigger open drain line.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkout[N].logic" - ] - }, - { - "name": "trigger.tsplinkin[N].edge", - "webhelpfile": "32539.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates which trigger edge controls the trigger event detector for a trigger line.", - "details": "When the edge is detected, the instrument asserts a TTL-low pulse for the output.The output state of the I/O line is controlled by the trigger logic. The user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger mode", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggertsplinkinedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "detectedEdge = trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[3].edge = trigger.EDGE_RISING;", - "description": "Sets synchronization line 3 to detect rising edge triggers as input.\n" - } - ], - "related_commands": [ - "digio.writeport()", - "tsplink.line[N].mode", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkout[N].logic", - "webhelpfile": "32540.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger output with output logic for a trigger line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggertsplinkoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "logicType = trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].logic = trigger.LOGIC_POSITIVE;", - "description": "Sets the trigger logic for synchronization line 3 to output a positive pulse.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].reset()", - "webhelpfile": "32541.htm", - "signature": "tsplink.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults.", - "details": "The tsplink.line[N].reset() function resets the following attributes to their default values:This also clears trigger.tsplinkin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes to default values.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].overrun", - "trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].stimulus", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].state", - "webhelpfile": "32542.htm", - "signature": "", - "command_return": "lineState", - "type": "Attribute (RW)", - "default_value": "tsplink.STATE_HIGH\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or writes the digital state of a TSP-Link synchronization line.", - "details": "Use tsplink.writeport() to write to all TSP-Link synchronization lines.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "lineState", - "description": "The state of the synchronization line", - "enum": "tsplink.STATE_LOW nil|tsplink.STATE_HIGH nil", - "type": "tsplinklinestatelineState", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "lineState = tsplink.line[N].state", - "tsplink.line[N].state = lineState" - ], - "overloads": [], - "examples": [ - { - "example": "lineState = tsplink.line[3].state;print(lineState);", - "description": "Assume line 3 is set high, and then the state is read.\n--- --Output:\n--- --tsplink.STATE_HIGH\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode", - "tsplink.writeport()" - ] - }, - { - "name": "trigger.tsplinkout[N].assert()", - "webhelpfile": "32549.htm", - "signature": "trigger.tsplinkout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding trigger event.", - "details": "Initiates a trigger event and does not wait for completion. The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].clear()", - "webhelpfile": "32551.htm", - "signature": "trigger.tsplinkin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. When this command is sent, the instrument:", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[2].clear();", - "description": "Clears the trigger event on TSP-Link line 2.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].overrun", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].overrun", - "webhelpfile": "32552.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = trigger.tsplinkin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkin[1].overrun);", - "description": "If an event on line 1 was ignored, displays true; if no additional event occurred, displays false.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.tsplinkout[N].pulsewidth", - "webhelpfile": "32553.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to 0 asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0.0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0.0 to 100 ks)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "trigger.tsplinkout[N].release()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].release()", - "webhelpfile": "32555.htm", - "signature": "trigger.tsplinkout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP-Link trigger line.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].stimulus", - "webhelpfile": "32558.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to trigger.EVENT_NONE.Do not use this attribute when triggering under script control. Use trigger.tsplinkout[N].assert() instead.The event parameters that you can use are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event identifier for the triggering event (see Details)", - "enum": "", - "type": "triggerEvents", - "range": "(see Details)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "event = trigger.tsplinkout[N].stimulus", - "trigger.tsplinkout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkout[3].stimulus);", - "description": "Outputs the event that will start action on TSP-Link trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkin[N].wait()", - "webhelpfile": "32561.htm", - "signature": "trigger.tsplinkin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events are detected since the last time this command or trigger.tsplinkin[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.tsplinkin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;triggered = trigger.tsplinkin[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on TSP-Link line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].clear()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "32565.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node.", - "details": "This attribute returns the node number of the master in a set of instruments connected using TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "localnode.version", - "webhelpfile": "32595.htm", - "signature": "", - "command_return": "version", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware version of the instrument.", - "details": "This attribute indicates the version number of the firmware that is presently running in the instrument.", - "param_info": [ - { - "name": "version", - "description": "Instrument version level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "version = localnode.version" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.version);", - "description": "Outputs the present version level. Example output:\n--- --1.0.0a\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "32597.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the instrument's serial number.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT2, \"Serial #: \" ..localnode.serialno);display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clears the instrument display.\n--- --Places the serial number of this instrument on the bottom line of the USER swipe screen display. Displays the USER swipe screen.\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.version" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "32628.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "The instrument automatically detects the power line frequency when the instrument is powered on. Power line frequency can be 50\u00a0Hz or 60\u00a0Hz.", - "param_info": [ - { - "name": "frequency", - "description": "The detected line frequency", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;print(frequency);", - "description": "Reads the line frequency setting.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "32684.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.runscript(myConnection, \"myTest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled myTest on the TSP-enabled instrument connected with myConnection.\n" - } - ], - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "smu.measure.configlist.size()", - "webhelpfile": "32926.htm", - "signature": "smu.measure.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the size (number of configuration indexes) of a measure configuration list.", - "details": "", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total count of indexes stored in the specified measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.measure.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.size(\"testMeasList\"));", - "description": "Returns the number of configuration indexes in a measure configuration list named testMeasList.\n--- --Example output:\n--- --1\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "localnode.access", - "webhelpfile": "33140.htm", - "signature": "", - "command_return": "accessType", - "type": "Attribute (RW)", - "default_value": "localnode.ACCESS_FULL\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the type of access users have to the instrument through different interfaces.", - "details": "When access is set to full, the instrument accepts commands from any interface with no login or password.When access is set to exclusive, you must log out of one remote interface and log into another one to change interfaces. You do not need a password with this access.Protected access is similar to exclusive access, except that you must enter a password when logging\u00a0in.When the access is set to locked out, a password is required to change interfaces, including the front-panel interface.Under any access type, if a script is running on one remote interface when a command comes in from another remote interface, the command is ignored and the message \"FAILURE: A script is running, use ABORT to stop it\" is generated.", - "param_info": [ - { - "name": "accessType", - "description": "The type of access", - "enum": "localnode.ACCESS_FULL nil|localnode.ACCESS_EXCLUSIVE nil|localnode.ACCESS_PROTECTED nil|localnode.ACCESS_LOCKOUT nil", - "type": "localnodeaccessaccessType", - "range": "" - } - ], - "usage": [ - "accessType = localnode.access", - "localnode.access = accessType" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.access = localnode.ACCESS_LOCKOUT;login admin;logout;", - "description": "Set the instrument access to locked out.\n--- --Log into the interface using the default password.\n--- --Log out of the interface.\n" - } - ], - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "smu.source.autodelay", - "webhelpfile": "33143.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the automatic delay that occurs when the source is turned on.", - "details": "When autodelay is turned on, the actual delay that is set depends on the range.When source autodelay is on, if you set a source delay, the autodelay is turned off.", - "param_info": [ - { - "name": "state", - "description": "Disable the source auto delay", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaystate", - "range": "" - }, - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaysourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautodelayfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.autodelay", - "smu.source.autodelay = state", - "state = smu.source.getattribute(function, ATTR_SRC_DELAY_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_DELAY_AUTO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.autodelay = smu.OFF;", - "description": "Turn off auto delay when current is being sourced.\n" - } - ], - "related_commands": [ - "smu.source.delay" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "33148.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.DISABLE\n", - "tsp_link": "No\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Do not generate prompts", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = localnode.ENABLE;", - "description": "Enable prompting.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "smu.source.configlist.recall()", - "webhelpfile": "33155.htm", - "signature": "smu.source.configlist.recall(listName, index, measureListName, measureIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a specific configuration index in a specific source configuration list and an optional measure configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a specific source configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified source configuration list of that index.You can optionally specify a measure configuration list and index to recall with the source settings. If you do not specify a measure index, the measure index defaults to match the source index. Specify a source and measure list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need have the application of the source and measure configuration lists coordinated, you can specify just the source configuration list with this command and use the smu.measure.configlist.recall() command to recall measure settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, event code 2790, \"Configuration list, error, does not exist\" is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. To see the settings that are recalled with an index, use the smu.source.configlist.query() command.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "measureListName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "measureIndex", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)", - "smu.source.configlist.recall(listName, index, measureListName, measureIndex)" - ], - "overloads": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)" - ], - "examples": [ - { - "example": "smu.source.configlist.recall(\"MySourceList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "trigger.lanout[N].logic", - "webhelpfile": "33157.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line.", - "details": "", - "param_info": [ - { - "name": "logicType", - "description": "The type of logic", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerlanoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "logicType = trigger.lanout[N].logic", - "trigger.lanout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[2].logic = trigger.LOGIC_POSITIVE;", - "description": "Set the logic for LAN trigger line 2 to positive.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digout[N].logic", - "webhelpfile": "33159.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the output logic of the trigger event generator to positive or negative for the specified line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerdigoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "logicType = trigger.digout[N].logic", - "trigger.digout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].logic = trigger.LOGIC_NEGATIVE;", - "description": "Sets line 4 mode to be a trigger output and sets the output logic of the trigger event generator to negative (asserts a low pulse).\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "33164.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This command is not available if the buffer style is set to compact.This read-only attribute is an array of status values for the readings in the buffer. The status values are floating-point numbers that encode the status value. Refer to the following table for values.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired; refer to Details", - "enum": "", - "type": "bufferVarstatuses", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.statuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --64, 64\n--- --Indicating that the status is buffer.STAT_LIMIT1_LOW.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.delete()", - "bufferVar.clear()", - "bufferVar.sourcestatuses", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.save()", - "webhelpfile": "33210.htm", - "signature": "buffer.save(bufferVar, fileName, what, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves data from the specified reading buffer to a USB flash drive.", - "details": "The file name must specify the full path (including /usb1/). If included, the file extension must be set to .csv. If no file extension is specified, .csv is added.Examples of valid destination file names:The Model 2460 does not check for existing files when you save. Verify that you are using a unique name to avoid overwriting any existing CSV files on the flash drive.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "what", - "description": "Defines which information is saved in the file on the USB flash drive", - "enum": "", - "type": "bufferFileSaveDetails", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, what)", - "buffer.save(bufferVar, fileName, what, start, end)" - ], - "overloads": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, what)" - ], - "examples": [ - { - "example": "buffer.save(MyBuffer, \"/usb1/myData.csv\");", - "description": "Save all reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Save all readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(defbuffer1, \"/usb1/defbuf1data\", buffer.SAVE_RAW_TIME);", - "description": "Save readings and raw time stamps from defbuffer1 to a file named defbuf1data on the USB flash drive.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.saveappend()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "33260.htm", - "signature": "display.prompt(buttonID, promptText)", - "command_return": "promptID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an interactive dialog prompt that displays a custom message on the front-panel display.", - "details": "This command displays buttons and text on the front panel. You can set up scripts that respond to the buttons when they are selected.If you send display.BUTTONS_NONE, the operator needs to press the EXIT key to clear the message from the front-panel display. You can also use the display.delete() command to remove the prompt.Only one prompt can be active at a time.When the user presses a button, the button presses are returned as one of the following options:To capture return values, you need to use display.waitevent() to wait for the user button selection.", - "param_info": [ - { - "name": "promptID", - "description": "A set of characters that identifies the prompt; up to 63 characters", - "enum": "", - "type": "promptID", - "range": "" - }, - { - "name": "buttonID", - "description": "The type of prompt to display; choose one of the following options", - "enum": "display.BUTTONS_NONE nil|display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displaypromptbuttonID", - "range": "" - }, - { - "name": "promptText", - "description": "A string that contains the text that is displayed above the prompts", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "promptID = display.prompt(buttonID, promptText)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.delete()", - "display.waitevent()" - ] - }, - { - "name": "display.waitevent()", - "webhelpfile": "33261.htm", - "signature": "display.waitevent(timeout)", - "command_return": "objectID, subID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to wait for a user to respond to a prompt that was created with a prompt command.", - "details": "This command waits until a user responds to a front-panel prompt that was created with the display.prompt() command.", - "param_info": [ - { - "name": "objectID", - "description": "A number that identifies the object, such as a prompt message, that is displayed on the front panel", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "subID", - "description": "The returned value after a button is pressed on the front panel", - "enum": "display.BUTTON_YES nil|display.BUTTON_NO nil|display.BUTTON_OK nil|display.BUTTON_CANCEL nil", - "type": "displaywaiteventsubID", - "range": "" - }, - { - "name": "timeout", - "description": "The amount of time to wait before timing out; time is 0 to 300 s, where the default of 0 waits indefinitely", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "objectID, subID = display.waitevent()", - "objectID, subID = display.waitevent(timeout)" - ], - "overloads": [ - "objectID, subID = display.waitevent()" - ], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start, and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.input.prompt()", - "display.prompt()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "33286.htm", - "signature": "script.load(file)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The name that is used for scriptVar must not already exist as a global variable. In addition, the scriptVar name must be a global reference and not a local variable, table, or array.For external scripts, the root folder of the USB flash drive has the absolute path /usb1/.", - "param_info": [ - { - "name": "file", - "description": "A string that contains the path and file name of the script file to load; if scriptVar is not defined, this name is used as the global variable name for this script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The created script; a global variable with this name is used to reference the script", - "enum": "", - "type": "scriptVar", - "range": "" - } - ], - "usage": [ - "script.load(file)", - "scriptVar = script.load(file)" - ], - "overloads": [ - "script.load(file)" - ], - "examples": [ - { - "example": "test8 = script.load(\"/usb1/testSetup.tsp\");", - "description": "Loads the script with the file name testSetup.tsp that is on the USB flash drive and names it test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.catalog()", - "webhelpfile": "33290.htm", - "signature": "for name in script.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script returned from script.catalog()", - "enum": "", - "type": "any", - "range": "()" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the return names from the catalog command", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "for name in script.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n--- --print(name) represent the body parameter shown in the Usage.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "33394.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from the run-time memory and nonvolatile memory.", - "details": "When a script is deleted, the global variable referring to this script is also deleted.You must delete an existing script before you can use the name of that script again. Scripts are not automatically overwritten.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory and the global variable named test8.\n" - } - ], - "related_commands": [ - "Deleting a user script using a remote interface", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "33395.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source code of a script.", - "details": "The body of the script is a single string with lines separated by the new line character.", - "param_info": [ - { - "name": "code", - "description": "The body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source" - ], - "overloads": [], - "examples": [ - { - "example": "print(test7.source);", - "description": "Assuming a script named test7 was created on the instrument, this example retrieves the source code.\n--- --Output:\n--- --reset()\n--- --display.settext(display.TEXT1, \"Text on line 1\")\n--- --display.settext(display.TEXT2, \"Text on line 2\")\n" - } - ], - "related_commands": [ - "scriptVar.save()" - ] - }, - { - "name": "display.lightstate", - "webhelpfile": "33459.htm", - "signature": "", - "command_return": "brightness", - "type": "Attribute (RW)", - "default_value": "display.STATE_LCD_50\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the light output level of the front-panel display.", - "details": "This command changes the light output of the front panel when a test requires different instrument illumination levels.The change in illumination is temporary. The normal backlight settings are restored after a power cycle. You can use this to reset a display that is already dimmed by the front-panel Backlight Dimmer.", - "param_info": [ - { - "name": "brightness", - "description": "The brightness of the display", - "enum": "display.STATE_LCD_100 nil|display.STATE_LCD_75 nil|display.STATE_LCD_50 nil|display.STATE_LCD_25 nil|display.STATE_LCD_OFF nil|display.STATE_BLACKOUT nil", - "type": "displaylightstatebrightness", - "range": "" - } - ], - "usage": [ - "brightness = display.lightstate", - "display.lightstate = brightness" - ], - "overloads": [], - "examples": [ - { - "example": "display.lightstate = display.STATE_LCD_50;", - "description": "Set the display brightness to 50%.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.preset()", - "webhelpfile": "33635.htm", - "signature": "status.preset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears the event registers and the enable registers for operation and questionable. It will not clear the Service Request Enable Register (*SRE) to Standard Request Enable Register (*ESE).Preset does not affect the event queue.The Standard Event Status Register is not affected by this command.", - "param_info": [ - { - "name": "status.preset()", - "description": "Resets the instrument status model.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.preset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.preset();", - "description": "Resets the instrument status model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "buffer.delete()", - "webhelpfile": "33981.htm", - "signature": "buffer.delete(bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a user-defined reading buffer.", - "details": "You cannot delete the default reading buffers, defbuffer1 and defbuffer2.After deleting the buffer, call collectgarbage() to reclaim the memory the buffer was using.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of a user-defined reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "buffer.delete(bufferName)" - ], - "overloads": [], - "examples": [ - { - "example": "buf400\u00a0= buffer.make(400);smu.measure.read(buf400);printbuffer(1, buf400.n, buf400.relativetimestamps);buffer.delete(buf400);collectgarbage();", - "description": "Create a 400-element reading buffer named buf400.\n--- --Make measurements and store the readings in buf400.\n--- --Print the relative timestamps for each reading in the buffer.\n--- --Example output, assuming five readings are stored in the buffer:\n--- --0, 0.412850017, 0.821640085, 1.230558058, 1.629523236\n--- --Delete buf400.\n--- --Use collectgarbage() to unallocate the buffer.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "printbuffer()" - ] - }, - { - "name": "trigger.timer[N].start.seconds", - "webhelpfile": "33984.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.seconds", - "trigger.timer[N].start.seconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.seconds = localnode.gettime() + 30;trigger.timer[1].enable = trigger.ON;", - "description": "Set the trigger timer to start 30 s from the time when the timer is enabled.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].start.fractionalseconds", - "webhelpfile": "33985.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the fractional seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time in fractional seconds (0 to <1 s)", - "enum": "", - "type": "number", - "range": "(0 to <1 s)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.fractionalseconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.fractionalseconds = 0.4;", - "description": "Set the trigger timer to start in 0.4\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].start.generate" - ] - }, - { - "name": "reset()", - "webhelpfile": "34054.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings and clears the buffers.", - "details": "The reset() command in its simplest form resets the entire TSP-enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use the node[N].reset() command. Also use the node[N].reset() command to reset an instrument on a subordinate node.When no value is specified for system, the default value is true.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error event.", - "param_info": [ - { - "name": "system", - "description": "If the node is the master, the entire system is reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error event is generated.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.sourcestatuses", - "webhelpfile": "34340.htm", - "signature": "bufferVar.sourcestatuses[N]", - "command_return": "statusInfo", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source status conditions of the instrument for the reading point.", - "details": "This buffer recall attribute holds an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value for each measurement made. See the following table for values.", - "param_info": [ - { - "name": "statusInfo", - "description": "The status value when reading N of the specified buffer was acquired; Source status values are", - "enum": "buffer.STAT_PROTECTION nil|buffer.STAT_READBACK nil|buffer.STAT_OVER_TEMP nil|buffer.STAT_LIMIT nil|buffer.STAT_SENSE nil|buffer.STAT_OUTPUT nil", - "type": "bufferVarsourcestatusesstatusInfo", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInfo = bufferVar.sourcestatuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.sourcestatuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --136, 136\n--- --Indicating that the status is buffer.STAT_READBACK and buffer.STAT_OUTPUT.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "buffer.delete()", - "print()", - "printbuffer()" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "34363.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP-enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "The termination type", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtermSequence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "34428.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event.Use none to disable the blender input.The event parameter may be any of the trigger events shown in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "triggerEvents[]", - "range": "" - }, - { - "name": "N", - "description": "An integer that represents the trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "buffer.clearstats()", - "webhelpfile": "34560.htm", - "signature": "buffer.clearstats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the statistical information associated with the specified buffer.", - "details": "This command clears the statistics without clearing the readings.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1 if not specified", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "buffer.clearstats()", - "buffer.clearstats(bufferVar)" - ], - "overloads": [ - "buffer.clearstats()" - ], - "examples": [ - { - "example": "buffer.clearstats();", - "description": "Clears statistics for defbuffer1.\n" - } - ], - "related_commands": [ - "buffer.getstats()" - ] - }, - { - "name": "createconfigscript()", - "webhelpfile": "34589.htm", - "signature": "createconfigscript(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a setup file that captures most of the present settings of the instrument.", - "details": "This function does not automatically overwrite existing scripts with the same name. If scriptName is set to the name of an existing script, an event message is returned. You must delete the existing script before using the same script name. This includes the autoexec script, which runs automatically when the instrument power is turned on. You can set scriptName to autoexec, but you must delete the existing autoexec script first using the script.delete(\"autoexec\") command.Once created, the script that contains the settings can be run and edited like any other script.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script that will be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "createconfigscript(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "createconfigscript(\"myConfigurationScript\");reset();myConfigurationScript();", - "description": "Capture the present settings of the instrument into a script named myConfigurationScript.\n--- --Reset the instrument.\n--- --Restore the settings stored in myConfigurationScript.\n" - } - ], - "related_commands": [ - "Saving setups", - "script.delete()" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "34629.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"admin\"\n", - "tsp_link": "No\n", - "description": "This attribute stores the instrument password.", - "details": "When the access to the instrument is set to protected or lockout, this is the password that is used to gain access.If you forget the password, you can reset the password to the default:You can also reset the password and the LAN settings from the rear panel by inserting a straightened paper clip into hole below LAN RESET.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the instrument password (maximum 30 characters)", - "enum": "", - "type": "string", - "range": "(maximum 30 characters)" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the password to N3wpa55w0rd.\n" - } - ], - "related_commands": [ - "localnode.access" - ] - }, - { - "name": "eventlog.post()", - "webhelpfile": "34730.htm", - "signature": "eventlog.post(message, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to post your own text to the event log.", - "details": "You can use this command to create your own event log entries and assign a severity level to them. This can be useful for debugging and status reporting.From the front panel, you must set the Log Warnings and Log Information options on to have the custom warning and information events placed into the event log.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "message", - "description": "String that contains the message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "The type of event; if no event is defined, defaults to eventlog.SEV_INFO", - "enum": "eventlog.SEV_INFO nil|eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil", - "type": "eventlogposteventType", - "range": "" - } - ], - "usage": [ - "eventlog.post(message)", - "eventlog.post(message, eventType)" - ], - "overloads": [ - "eventlog.post(message)" - ], - "examples": [ - { - "example": "eventlog.clear();eventlog.post(\"Results in \\018\", eventlog.SEV_ERROR);print(eventlog.next());", - "description": "Posts an event that states \"Results in \u03a9\".\n--- --Output:\n--- --1005 User: Results in \u03a9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.usbdriveexists()", - "webhelpfile": "34905.htm", - "signature": "file.usbdriveexists()", - "command_return": "driveInserted", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function detects if a USB flash drive is inserted into the front-panel USB port.", - "details": "You can call this command from a script to verify that a USB flash drive is inserted before attempting to write data to it.", - "param_info": [ - { - "name": "driveInserted", - "description": "0", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "driveInserted = file.usbdriveexists()" - ], - "overloads": [], - "examples": [ - { - "example": "local response;local xMax = 10;\u00a0;for x = 1, xMax do; -- Make xMax readings and store them in defbuffer1.; smu.measure.read();end;\u00a0;if (file.usbdriveexists() == 1) then ; response = display.BUTTON_YES;else; response = display.input.prompt(display.BUTTONS_YESNO, \"Insert a USB flash drive.\\nPress Yes to write data or No to not write data.\") ;end;\u00a0;if (response == display.BUTTON_YES) then; if (file.usbdriveexists() == 1) then ; FileNumber = file.open(\"/usb1/TenReadings.csv\", file.MODE_WRITE); file.write(FileNumber,\"Reading,Seconds\\n\");\u00a0; -- Print out the measured values in a two-column format.; print(\"\\nIteration:\\tReading:\\tTime:\\n\");\u00a0; for i = 1, xMax do; print(i, defbuffer1[i], defbuffer1.relativetimestamps[i]); file.write(FileNumber, string.format(\"%g, %g\\r\\n\",defbuffer1.readings[i], defbuffer1.relativetimestamps[i])); end; file.close(FileNumber); else; response = display.input.prompt(display.BUTTONS_OK,; \"No drive detected. Allow more time after inserting a drive.\") ; end;end;", - "description": "Make measurements.\n--- --Verify that a flash drive is inserted into the instrument.\n--- --If the flash drive is inserted, write the data to the flash drive.\n--- --Print data into a two-column format.\n--- --If the flash drive is not inserted after selecting Yes, another prompt is displayed.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.userdelay[N]", - "webhelpfile": "34973.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay in seconds (0 to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 to 10 ks)" - }, - { - "name": "N", - "description": "The number that identifies this user delay (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.source.userdelay[N]", - "smu.source.userdelay[N] = delayTime", - "delayTime = smu.source.getattribute(function, ATTR_SRC_USER_DELAY_N)", - "smu.source.setattribute(function, ATTR_SRC_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_S1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for source 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls source user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "35118.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to two) on which to wait", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n--- --Wait 3 s while checking if trigger blender 1 event has occurred.\n" - } - ], - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.model.load() - ConfigList", - "webhelpfile": "35126.htm", - "signature": "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that uses source and measure configuration lists.", - "details": "This trigger-model template incorporates a source configuration list and measure configuration list. You must set up the configuration lists before loading the trigger model. If the configuration lists change, you must resend this command.You can also set a delay and change the reading buffer.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "ConfigList", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "measureConfigList", - "description": "A string that contains the name of the measurement configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceConfigList", - "description": "A string that contains the name of the source configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"SOURCE_LIST\");smu.measure.configlist.create(\"MEASURE_LIST\");smu.source.level = 1;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 1e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 5;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 10e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 10;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 100e-3;smu.measure.configlist.store(\"MEASURE_LIST\");trigger.model.load(\"ConfigList\", \"MEASURE_LIST\", \"SOURCE_LIST\");trigger.model.initiate();", - "description": "Set up a source configuration list named SOURCE_LIST and a measurement configuration list named MEASURE_LIST. Load the configuration list trigger model, using these two configuration lists. Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - Empty", - "webhelpfile": "35127.htm", - "signature": "trigger.model.load(Empty)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger model.", - "details": "When you load this trigger-model template, any blocks that have been defined in the trigger model are cleared so the trigger model has no blocks defined.", - "param_info": [ - { - "name": "Empty", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "trigger.model.load(\"Empty\")print(trigger.model.getblocklist())", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Clear the trigger model to have no blocks defined.Output:EMPTY", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.load(Empty)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model to have no blocks defined.\n--- --Output:\n--- --EMPTY\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LogicTrigger", - "webhelpfile": "35128.htm", - "signature": "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a logic trigger through the digital I/O.", - "details": "This trigger model waits for a digital input event to occur, makes a measurement, and issues a notify event. The notify event asserts a digital output line.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.This command replaces the trigger.model.load() \u2014 ExternalTrigger command, which is deprecated. Note that the clear parameter is not available for ExternalTrigger.", - "param_info": [ - { - "name": "LogicTrigger", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "digInLine", - "description": "The digital input line (1 to 6); also, the event that the trigger model will wait on in block\u00a01", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "digOutLine", - "description": "The digital output line (1 to 6)", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLogicTriggerclear", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)" - ], - "examples": [ - { - "example": "trigger.model.load(\"LogicTrigger\", 1, 2, 10, 0.001, defbuffer1);", - "description": "Set up the template to use the digital in line and wait for a pulse from digital in line 1 to trigger measurements.\n--- --Pulse digital out line 2 when the measurement is complete.\n--- --Make 10 measurements, with a delay of 1\u00a0ms before each measurement.\n--- --Store the measurements in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.digout[N].logic" - ] - }, - { - "name": "trigger.model.load() \u2014 Simple Loop", - "webhelpfile": "35129.htm", - "signature": "trigger.model.load(SimpleLoop, count, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a predefined trigger model configuration that does a specified number of measurements.", - "details": "This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the count parameter.", - "param_info": [], - "usage": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)", - "trigger.model.load(SimpleLoop, count, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)" - ], - "examples": [ - { - "example": "reset(); ;--set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;--set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;--turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;--Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;--Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses the Simple Loop trigger model template to do a capacitor test. This example produces 200 readings that have output similar to the following example:\n--- --Rdg #\tTime (s)\tCurrent (A)\n--- --1\t0 8.5718931952528e-11\n--- --2\t0.151875 1.6215984111057e-10\n--- --3\t0.303727 1.5521139928865e-10\n--- --. . .\n--- --198\t29.91579194\t1.5521250951167e-10\n--- --199\t30.067648716\t1.4131290582142e-10\n--- --200\t30.219497716\t1.5521067764368e-10\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_LOG_EVENT", - "webhelpfile": "35428.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to log an event in the event log when the trigger model is running.", - "details": "Note that using this block too often in a trigger model could overflow the event log. It may also take away from the time needed to process more critical trigger model blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "eventNumber", - "description": "The event number", - "enum": "trigger.LOG_INFO nil|trigger.LOG_WARN nil|trigger.LOG_ERROR nil|trigger.LOG_WARN_ABORT nil", - "type": "triggermodelsetblocktriggerBLOCK_LOG_EVENTeventNumber", - "range": "" - }, - { - "name": "message", - "description": "A string up to 31 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_LOG_EVENT, trigger.LOG_INFO2, \"Trigger model complete.\");", - "description": "Set trigger model block 9 to log an event when the trigger model completes. In the event log, the message is:\n--- --TM #1 block #9 logged: Trigger model complete.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_NOP", - "webhelpfile": "35431.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a placeholder that performs no action in the trigger model; available only using remote commands.", - "details": "If you remove a trigger model block, you can use this block as a placeholder for the block number so that you do not need to renumber the other blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_NOP);", - "description": "Set block number 4 to be a no operation block.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.delete()", - "webhelpfile": "38977.htm", - "signature": "display.delete(promptID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to remove a prompt on the front-panel display that was created with display.prompt().", - "details": "You can use this command to remove the presently displayed prompt.", - "param_info": [ - { - "name": "promptID", - "description": "The identifier defined by display.prompt()", - "enum": "", - "type": "promptID", - "range": "()" - } - ], - "usage": [ - "display.delete(promptID)" - ], - "overloads": [], - "examples": [ - { - "example": "removePrompt3 = display.prompt(display.BUTTONS_NONE, \"This prompt will disappear in 3 seconds\");delay(3);display.delete(removePrompt3);", - "description": "This example displays a prompt that is automatically removed in three seconds.\n--- --\n" - } - ], - "related_commands": [ - "display.prompt()" - ] - }, - { - "name": "eventlog.suppress()", - "webhelpfile": "40049.htm", - "signature": "eventlog.suppress(eventNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This command allows you to suppress system events from generating a popup on the front\u2011panel interface.", - "details": "The eventType parameter allows you to suppress groups of events (errors, warnings, and information). You can combine the event types to suppress more than one type. For example, to suppress information and error events, send the command:You can use the eventNumber parameter to suppress individual system events.This command does not prevent system events from appearing in the event log or in a file on a USB flash drive if the event log is saved.An event number is the number that accompanies an error, warning, or information message that is reported in the event log. For example, for the error \"Error -109, Missing parameter,\" the event number is -109. Note that some messages that are displayed on the front panel are not recorded in the event log. Only messages that include an event number can be suppressed.", - "param_info": [ - { - "name": "eventType", - "description": "The type of the event to be suppressed", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsuppresseventType", - "range": "" - }, - { - "name": "eventNumber", - "description": "The number of a specific event to be suppressed", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "eventlog.suppress(eventType)", - "eventlog.suppress(eventNumber)" - ], - "overloads": [ - "eventlog.suppress(eventType)" - ], - "examples": [ - { - "example": "eventlog.suppress(-109);", - "description": "Suppress -109, the missing parameter message, from displaying a popup on the front panel.\n" - } - ], - "related_commands": [ - "eventlog.save()" - ] - }, - { - "name": "display.input.number()", - "webhelpfile": "40051.htm", - "signature": "display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)", - "command_return": "numberEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that requests a number from the user on the front-panel display.", - "details": "This command prompts the instrument operator to enter a value.The prompt is displayed until it has been responded to.", - "param_info": [ - { - "name": "numberEntered", - "description": "The number that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; can be up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "numberFormat", - "description": "The format of the displayed number", - "enum": "display.NFORMAT_INTEGER nil|display.NFORMAT_DECIMAL nil|display.NFORMAT_EXPONENT nil|display.NFORMAT_PREFIX nil", - "type": "displayinputnumbernumberFormat", - "range": "" - }, - { - "name": "defaultValue", - "description": "The value that is initially displayed in the displayed keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimumValue", - "description": "The lowest value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximumValue", - "description": "The highest value that can be entered", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)" - ], - "overloads": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)" - ], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;testcurrent = display.input.number(\"Enter a Test Current (0 to 1 A)\", display.NFORMAT_PREFIX, 0, 0, 1);smu.source.level = testcurrent;", - "description": "This example displays a number pad on the screen that defaults to 0 and allows entries from 0 to 1. The number that the operator enters is assigned to the source current level. If the operator enters a value outside of the range, an error message is displayed.\n--- --\n" - } - ], - "related_commands": [ - "display.input.option()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.option()", - "webhelpfile": "40052.htm", - "signature": "display.input.option(dialogTitle, buttonTitle1, ...)", - "command_return": "BUTTON_OPTIONn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an option dialog box with customizable buttons on the front-panel display.", - "details": "Buttons are created from top to bottom, left to right. If you have more than five buttons, they are placed into two columns.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "n", - "description": "The number of the button that is selected from the front-panel display; nil if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right", - "enum": "", - "type": "display_BUTTON_OPTIONs | nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "buttonTitle1", - "description": "A string that contains the name of the first button; up to 15 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "A string that contains the names of subsequent buttons, where N is a number from 2 to 10; you can define up to 10 buttons; each button can be up to 15 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "BUTTON_OPTIONn = display.input.option(dialogTitle, buttonTitle1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "optionID = display.input.option(\"Select an option\", \"Apple\", \"Orange\", \"Papaya\", \"Pineapple\", \"Blueberry\", \"Banana\", \"Grapes\", \"Peach\", \"Apricot\", \"Guava\");print(optionID);", - "description": "This example displays the following dialog box:\n--- --\n--- --If the user selects Peach, the return is display.BUTTON_OPTION8.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.prompt()", - "webhelpfile": "40053.htm", - "signature": "display.input.prompt(buttonSet, dialogTitle)", - "command_return": "buttonReturn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that accepts a user response from the front-panel display.", - "details": "This command waits for a user response to the prompt. You can use the text to ask questions that can be used to configure your test.The prompt is displayed until it has been responded to by the user. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "buttonReturn", - "description": "Indicates which button was pressed", - "enum": "display.BUTTON_OK nil|display.BUTTON_CANCEL nil|display.BUTTON_YES nil|display.BUTTON_NO nil", - "type": "displayinputpromptbuttonReturn", - "range": "" - }, - { - "name": "buttonSet", - "description": "The set of buttons to display", - "enum": "display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displayinputpromptbuttonSet", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 63 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buttonReturn = display.input.prompt(buttonSet, dialogTitle)" - ], - "overloads": [], - "examples": [ - { - "example": "result = display.input.prompt(display.BUTTONS_YESNO, \"Do you want to display the graph screen?\");if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "This displays the prompt \"Do you want to display the graph screen?\" on the front-panel display:\n--- --\n--- -- If the operator selects Yes, the graph screen is displayed.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.string()" - ] - }, - { - "name": "display.input.string()", - "webhelpfile": "40054.htm", - "signature": "display.input.string(dialogTitle, textFormat)", - "command_return": "textEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a dialog box that requests text from the user through the front-panel display.", - "details": "This command creates a prompt to the instrument operator to enter a string value.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "textEntered", - "description": "The text that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "textFormat", - "description": "The format of the entered text", - "enum": "display.SFORMAT_ANY nil|display.SFORMAT_UPPER_LOWER nil|display.SFORMAT_UPPER nil|display.SFORMAT_BUFFER_NAME nil", - "type": "displayinputstringtextFormat", - "range": "" - } - ], - "usage": [ - "textEntered = display.input.string(dialogTitle)", - "textEntered = display.input.string(dialogTitle, textFormat)" - ], - "overloads": [ - "textEntered = display.input.string(dialogTitle)" - ], - "examples": [ - { - "example": "value = display.input.string(\"Enter Test Name\", display.SFORMAT_ANY);print(value);", - "description": "This example displays the prompt \"Enter Test Name\" and a keyboard that the operator can use to enter a response.\n--- --\n--- --The return is the response from the operator.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.prompt()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "40235.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.ENABLE\n", - "tsp_link": "No\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = localnode.DISABLE;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "smu.measure.limit[Y].audible", - "webhelpfile": "41684.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.AUDIBLE_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument beeper sounds when a limit test passes or fails.", - "details": "The tone and length of beeper cannot be adjusted.See smu.measure.limit[Y].fail for an example of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "When the beeper sounds", - "enum": "smu.AUDIBLE_NONE nil|smu.AUDIBLE_FAIL nil|smu.AUDIBLE_PASS nil", - "type": "smumeasurelimitaudiblestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitaudiblefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].audible", - "smu.measure.limit[Y].audible = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "state;", - "description": "When the beeper sounds:\n--- --Never: smu.AUDIBLE_NONEOn test failure: smu.AUDIBLE_FAILOn test pass: smu.AUDIBL" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": " trigger.BLOCK_RESET_BRANCH_COUNT", - "webhelpfile": "41689.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a block in the trigger model that resets a branch counter to 0.", - "details": "When the trigger model reaches the Counter Reset block, it resets the count of the specified Branch on Counter block to zero.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "counter", - "description": "The block number of the counter that is to be reset", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 5, 2);trigger.model.setblock(4, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 3, 2);trigger.model.setblock(6, trigger.BLOCK_RESET_BRANCH_COUNT, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and take 5 readings.\n--- --Delay a second.\n--- --Loop three more times back to block 2.\n--- --Reset block 3 to 0.\n--- --Start the trigger model and wait for measurements to complete.\n--- --Print the number of readings in the buffer.\n--- --Output:\n--- --15\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.load() - SimpleLoop", - "webhelpfile": "46034.htm", - "signature": "trigger.model.load(SimpleLoop, count, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes a specific number of measurements.", - "details": "This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the Count parameter.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger-model blocks in a list format.", - "param_info": [ - { - "name": "SimpleLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)", - "trigger.model.load(SimpleLoop, count, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses the SimpleLoop trigger-model template to do a capacitor test. This example produces 200 readings that have output similar to the following example:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LoopUntilEvent", - "webhelpfile": "46040.htm", - "signature": "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements until the specified event occurs.", - "details": "The event constant is the event that ends infinite triggering or ends readings set to occur before the trigger and start post-trigger readings. The trigger model makes readings until it detects the event constant. After the event, it makes a finite number of readings, based on the setting of the trigger position.The position marks the location in the reading buffer where the trigger will occur. The position is set as a percentage of the buffer capacity. The buffer captures measurements until a trigger occurs. When the trigger occurs, the buffer retains the percentage of readings specified by the position, then captures remaining readings until 100\u00a0percent of the buffer is filled. For example, if this is set to 75 for a reading buffer that holds 10,000 readings, the trigger model makes 2500 readings after it detects the source event. There are 7500 pre-trigger readings and 2500 post-trigger readings.The instrument makes two sets of readings. The first set is made until the trigger event occurs. The second set is made after the trigger event occurs, up to the number of readings calculated by the position parameter.You cannot have the event constant set at none when you run this trigger-model template.The following table lists the options that are available for triggerEvent.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "LoopUntilEvent", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "triggerEvent", - "description": "The event that ends infinite triggering or readings set to occur before the trigger; see Details", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "position", - "description": "The number of readings to make in relation to the size of the reading buffer; enter as a percentage (0% to 100%)", - "enum": "", - "type": "number", - "range": "(0% to 100%)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block (default)", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLoopUntilEventclear", - "range": "(default)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Initiate readings;trigger.model.load(\"LoopUntilEvent\", trigger.EVENT_DISPLAY, 50);trigger.model.initiate();", - "description": "Reset the instrument.\n--- --Set the instrument to measure current.\n--- --Load the LoopUntilEvent trigger model to make measurements until the front panel trigger key is pressed, then continue to make measurements equal to 50% of the reading buffer size.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - GradeBinning", - "webhelpfile": "46058.htm", - "signature": "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a grading operation.", - "details": "This trigger-model template allows you to grade components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the pass pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "GradeBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 1; range 1 to 15; default is\u00a01", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 2; range 1 to 15; default is\u00a02", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 3; range 1 to 15; default is\u00a04", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 4; range 1 to 15; default is\u00a08", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have passed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - SortBinning", - "webhelpfile": "46066.htm", - "signature": "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a sorting operation.", - "details": "This trigger-model template allows you to sort components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the all fail pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "SortBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 1; range 1 to 15; default is 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 2; range 1 to 15; default is 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 3; range 1 to 15; default is 4", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 4; range 1 to 15; default is 8", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have failed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.extravalues", - "webhelpfile": "46323.htm", - "signature": "bufferVar.extravalues[N]", - "command_return": "extraValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the additional values in a reading buffer.", - "details": "This attribute contains an additional value, such as the extra value written to a writable buffer. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extravalue", - "description": "The extra values for readings", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraValue = bufferVar.extravalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.write.format()", - "webhelpfile": "46427.htm", - "signature": "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the units and number of digits of the readings that are written into the reading buffer.", - "details": "This command is valid when the buffer style is writable or full writable. When the buffer style is set to full writable, you can include an extra value.The format defines the units and the number of digits that are reported for the data. This command affects how the data is shown in the reading buffer and what is shown on the front-panel Home, Histogram, Reading Table, and Graph screens.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "units", - "description": "The units for the first measurement in the buffer index", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "bufferwriteformatunits", - "range": "" - }, - { - "name": "displayDigits", - "description": "The number of digits to use for the first measurement", - "enum": "buffer.DIGITS_3_5 nil|buffer.DIGITS_4_5 nil|buffer.DIGITS_5_5 nil|buffer.DIGITS_6_5 nil|buffer.DIGITS_7_5 nil|buffer.DIGITS_8_5 nil", - "type": "bufferwriteformatdisplayDigits", - "range": "" - }, - { - "name": "extraUnits", - "description": "The units for the second measurement in the buffer index; the selections are the same as units (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for units", - "enum": "", - "type": "bufferwriteformatunits", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "extraDigits", - "description": "The number of digits to use for the second measurement; the selections are the same as displayDigits (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for displayDigits", - "enum": "", - "type": "bufferwriteformatdisplayDigits", - "range": "(only valid for buffer style WRITABLE_FULL)" - } - ], - "usage": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)" - ], - "overloads": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1.0000000000e+00, Watt DC, 2.0000000000e+00, Watt DC, 3.0000000000e+00, Watt DC, 4.0000000000e+00, Watt DC, 5.0000000000e+00, Watt DC, 6.0000000000e+00, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.reading()" - ] - }, - { - "name": "buffer.write.reading()", - "webhelpfile": "46428.htm", - "signature": "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to write readings into the reading buffer.", - "details": "For buffers that are set to the writable buffer style:For buffers that are set to the full writable buffer style:This command writes the data you specify into a reading buffer. The reading buffer must be set to the writable or full writable style, which is set when you make the buffer.Data must be added in chronological order. If the time is not specified for a reading, it is set to one integer second after the last reading. As you write the data, the front-panel home screen updates and displays the reading you entered.The status parameter provides additional information about the reading. The options are shown in the following table.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "readingValue", - "description": "The first value that is recorded in the buffer index", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "extraValue", - "description": "A second value that is recorded in the buffer index (only valid for buffer style WRITABLE_FULL)", - "enum": "", - "type": "integer", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "seconds", - "description": "An integer that represents the seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractionalSeconds", - "description": "The portion of the time that represents the fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "status", - "description": "Additional information about the reading; see Details", - "enum": "", - "type": "readingStatus", - "range": "" - } - ], - "usage": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)" - ], - "overloads": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.startindex", - "webhelpfile": "56793.htm", - "signature": "bufferVar.startindex", - "command_return": "startIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the starting index in a reading buffer.", - "details": "Use this attribute to find the starting index in a reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Starting index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.startindex = startIndex " - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n" - } - ], - "related_commands": [ - "bufferVar.endindex", - "buffer.make()" - ] - }, - { - "name": "bufferVar.endindex", - "webhelpfile": "56794.htm", - "signature": "bufferVar.endindex", - "command_return": "endIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the last index in a reading buffer.", - "details": "Use this attribute to find the ending index in a reading buffer.", - "param_info": [ - { - "name": "endIndex", - "description": "Ending index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.endindex = endIndex" - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);smu.measure.read(test1);print(test1.startindex, test1.endindex);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n--- --Make six more measurements and store them in buffer test1.\n--- --Get the start index and end index of test1.\n--- --Output:\n--- --1, 12\n" - } - ], - "related_commands": [ - "bufferVar.startindex", - "buffer.make()" - ] - }, - { - "name": "trigger.model.pause()", - "webhelpfile": "72471.htm", - "signature": "trigger.model.pause()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function pauses a running trigger model.", - "details": "This command pauses the trigger model.To continue the trigger model, send the resume command.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.pause()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.resume()" - ] - }, - { - "name": "trigger.model.resume()", - "webhelpfile": "73512.htm", - "signature": "trigger.model.resume()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function continues a paused trigger model.", - "details": "This command continues running the trigger model operation if the trigger model was paused.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.resume()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.pause()" - ] - }, - { - "name": "buffer.math()", - "webhelpfile": "73595.htm", - "signature": "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to run a mathematical expression on a measurement. The expression is applied when the measurement is placed in the reading buffer.", - "details": "", - "param_info": [ - { - "name": "readingBuffer", - "description": "The name of the reading buffer; the reading buffer selected must be set to the style FULL", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "unit", - "description": "The units to be applied to the value generated by the expression", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "buffermathunit", - "range": "" - }, - { - "name": "constant0", - "description": "The constant to be used for c0 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant1", - "description": "The constant to be used for c1 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant2", - "description": "The constant to be used for c2 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant3", - "description": "The constant to be used for c3 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant4", - "description": "The constant to be used for c4 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant5", - "description": "The constant to be used for c5 in the expression", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)" - ], - "overloads": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)" - ], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;\u00a0;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);\u00a0;print(\"Extra value reading 1: \", mathExp.extravalues[1]);print(\"Extra value reading 2: \", mathExp.extravalues[2]);print(\"Extra value reading 3: \", mathExp.extravalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: 6.3863430578e-05\n--- --Reading: 6.7818055872e-05\n--- --Reading: 1.9871571784e-05\n--- --Extra value reading 1: 6.3863430578e-05\n--- --Extra value reading 2: 4.3310937031e-09\n--- --Extra value reading 3: 1.3476513655e-09\n" - } - ], - "related_commands": [ - "buffer.unit()" - ] - }, - { - "name": "buffer.unit()", - "webhelpfile": "76401.htm", - "signature": "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create up to three custom units of measure for use in buffers.", - "details": "You can use custom units of measures in buffer math and writable buffers.If you specify more than two characters, the additional characters are ignored. Some characters are converted to other symbols:This unit is reset when power is cycled. It is not affected by reset.", - "param_info": [ - { - "name": "UNIT_CUSTOMN", - "description": "Custom unit user can create, The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "bufferCustomUnit", - "range": "" - }, - { - "name": "N", - "description": "The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "unitOfMeasure", - "description": "A string that defines the custom unit; up to three characters; defaults are X for custom unit 1, Y for unit 2, and Z for unit 3", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.unit(buffer.UNIT_CUSTOM1, \"fb\") ;\u00a0;buffer.math(mathExp, buffer.UNIT_CUSTOM1, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading \"..x..\":\", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);for x = 1, 3 do ; print(\"Extra value reading \"..x..\":\", mathExp.extravalues[x]);end;", - "description": "Instrument has terminals set to FRONT.\n--- --Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the customer 1 buffer unit to fb.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make 3 readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading 1: 0.00015611271869\n--- --Reading 2: 9.0539004907e-05\n--- --Reading 3: 0.30001141669554\n--- --Extra value reading 1: 0.00015611271869\n--- --Extra value reading 2: 1.4134290203e-08\n--- --Extra value reading 3: 1.0336562635e-08\n" - } - ], - "related_commands": [ - "buffer.math()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.extraformattedvalues", - "webhelpfile": "81089.htm", - "signature": "bufferVar.extraformattedvalues[N]", - "command_return": "extraFormat", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement and the unit of measure of the additional values in a reading buffer.", - "details": "This attribute contains the measurement and the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraFormat", - "description": "The measurement and unit of measure of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraFormat = bufferVar.extraformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(400, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;display.changescreen(display.SCREEN_READING_TABLE);print(\"Extra value reading 1: \", mathExp.extraformattedvalues[1]);print(\"Extra value reading 2: \", mathExp.extraformattedvalues[2]);print(\"Extra value reading 3: \", mathExp.extraformattedvalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 400 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: \t7.1233589551e-06\n--- --Reading: \t7.1233080234e-06\n--- --Reading: \t7.2616603575e-06\n--- --Extra value reading 1: \t+7.1233590 u\n--- --Extra value reading 2: \t+50.741880 p\n--- --Extra value reading 3: \t+51.727043 p\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.extravalueunits", - "webhelpfile": "81090.htm", - "signature": "bufferVar.extravalueunits[N]", - "command_return": "extraUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of the additional values in a reading buffer.", - "details": "This attribute contains the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraUnits", - "description": "The units of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraUnits = bufferVar.extravalueunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.extravalueunits);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and extra value units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.activebuffer", - "webhelpfile": "81840.htm", - "signature": "", - "command_return": "bufferName", - "type": "Attribute (RW)", - "default_value": "defbuffer1\n", - "tsp_link": "Yes\n", - "description": "This attribute determines which buffer is used for measurements that are displayed on the front panel.", - "details": "The buffer defined by this command is used to store measurements data and is shown in the reading buffer indicator on the home screen of the instrument.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of the buffer to make active", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferName = display.activebuffer", - "display.activebuffer = bufferName" - ], - "overloads": [], - "examples": [ - { - "example": "display.activebuffer = buffer2;", - "description": "Set the front panel to use buffer2 as the active reading buffer.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.continuous", - "webhelpfile": "88463.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "trigger.CONT_AUTO\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the trigger mode setting after bootup.", - "details": "Conditions must be valid before continuous measurements can start.When the restart parameter is selected, the instrument is placed in local mode, aborts any running scripts, and aborts any trigger models that are running. If the command is in a script, it is the last command that runs before the script is aborted. The restart parameter is not stored in nonvolatile memory, so it does not affect start up behavior.The off and automatic parameters are stored in nonvolatile memory, so they affect start up behavior.", - "param_info": [ - { - "name": "setting", - "description": "Do not start continuous measurements after boot", - "enum": "trigger.CONT_OFF nil|trigger.CONT_AUTO nil|trigger.CONT_RESTART nil", - "type": "triggercontinuoussetting", - "range": "" - } - ], - "usage": [ - "setting = trigger.continuous", - "trigger.continuous = setting" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.continuous = trigger.CONT_OFF;", - "description": "When the instrument starts up, the measurement method is set to idle.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.autorangerebound", - "webhelpfile": "88860.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument restores the measure range to match the limit range after making a measurement.", - "details": "When autorange rebound is enabled, it prevents the source from being limited to a value that is below the source limit. After an autoranged measurement is made, the measure range is restored to match the limit range once the autoranged measurement is complete. This ensures that the source does not limit at less than the full limit setting.", - "param_info": [ - { - "name": "state", - "description": "Do not restore the measurement range after each measurement", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangereboundstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangereboundfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autorangerebound", - "smu.measure.autorangerebound = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_RANGE_REBOUND)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_REBOUND, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;smu.measure.autorangerebound = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n--- --Set the measure range to be automatically restored to match the source limit value after each measurement.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.interlock.enable", - "webhelpfile": "88873.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the output can be turned on when the interlock is not engaged.", - "details": "", - "param_info": [ - { - "name": "state", - "description": "Allow the output to be turned on when the interlock is not engaged", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlockenablestate", - "range": "" - } - ], - "usage": [ - "state = smu.interlock.enable", - "smu.interlock.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "smu.interlock.enable = smu.ON;", - "description": "The source output is disabled unless the interlock is engaged.\n" - } - ], - "related_commands": [ - "smu.interlock.tripped" - ] - }, - { - "name": "available()", - "webhelpfile": "89066.htm", - "signature": "available(functionality)", - "command_return": "presence", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks for the presence of specific instrument functionality.", - "details": "", - "param_info": [ - { - "name": "presence", - "description": "If the functionality is present, returns true; if not, returns false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "functionality", - "description": "The functionality to check for", - "enum": "", - "type": "functionality", - "range": "" - } - ], - "usage": [ - "presence = available(functionality)" - ], - "overloads": [], - "examples": [ - { - "example": "print(available(gpib));", - "description": "Returns true if GPIB communications are available. Returns false if GPIB communications are not available.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.getattribute()", - "webhelpfile": "91266.htm", - "signature": "smu.measure.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuregetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to smu.measure.setattribute() for available settings", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "()" - } - ], - "usage": [ - "value = smu.measure.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_RANGE));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_NPLC));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_DIGITS));", - "description": "Retrieve the range, NPLC, and digits settings for the DC voltage function.\n--- --Example return:\n--- --0.02\n--- --1\n--- --smu.DIGITS_4_5\n" - } - ], - "related_commands": [ - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.measure.configlist.storefunc()", - "webhelpfile": "91273.htm", - "signature": "smu.measure.configlist.storefunc(listName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a measure function into a measure configuration list whether or not the function is active.", - "details": "You must create the configuration list before using this command.If index is not specified, the settings are stored to the next available index in the configuration list.", - "param_info": [ - { - "name": "listName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The measure function settings to save into the configuration list", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.storefunc(listName, function)", - "smu.measure.configlist.storefunc(listName, function, index)" - ], - "overloads": [ - "smu.measure.configlist.storefunc(listName, function)" - ], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);\u00a0;", - "description": "Create a measure configuration list named MyMeasList.\n--- --Store the attributes for the DC Voltage settings in index\u00a01.\n--- --\u00a0\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()", - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.source.configlist.storefunc()", - "webhelpfile": "91274.htm", - "signature": "smu.source.configlist.storefunc(ConfigListName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a source function into a source configuration list whether or not the function is active.", - "details": "The configuration list must be created before you send this function.", - "param_info": [ - { - "name": "ConfigListName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The function to save into the configuration list", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.storefunc(ConfigListName, function)", - "smu.source.configlist.storefunc(ConfigListName, function, index)" - ], - "overloads": [ - "smu.source.configlist.storefunc(ConfigListName, function)" - ], - "examples": [ - { - "example": "smu.source.configlist.create(\"sourcelist\");smu.source.configlist.storefunc(\"sourcelist\", smu.FUNC_DC_CURRENT);", - "description": "Create a configuration list named sourcelist.\n--- --Store the settings for the DC current source function into the configuration list in index 1.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.source.setattribute()", - "webhelpfile": "91275.htm", - "signature": "smu.source.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a source function whether or not the function is active.", - "details": "You can set the following parameters. The links in the list below link to the descriptions of the corresponding TSP command descriptions. The settings available for each parameter are the same as the settings for the TSP commands.The parameters you can set are:", - "param_info": [ - { - "name": "function", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcesetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The parameter to be set; see Details", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "" - }, - { - "name": "value", - "description": "The function or setting value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_RANGE, 0.007);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY, 0.35);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_LEVEL, 0.035);", - "description": "Sets the range, delay, and level settings for DC current, whether or not DC current is the active function.\n" - } - ], - "related_commands": [ - "smu.source.configlist.storefunc()", - "smu.source.getattribute()", - "" - ] - }, - { - "name": "smu.source.getattribute()", - "webhelpfile": "91276.htm", - "signature": "smu.source.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcegetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The setting of the attribute; refer to smu.source.setattribute() for the list of attributes", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "()" - } - ], - "usage": [ - "value = smu.source.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.getattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY));", - "description": "Retrieve the source delay setting for DC current.\n--- --Example return:\n--- --1.05e-07\n" - } - ], - "related_commands": [ - "smu.source.setattribute()" - ] - }, - { - "name": "smu.measure.setattribute()", - "webhelpfile": "91445.htm", - "signature": "smu.measure.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a measure function whether or not the function is active.", - "details": "The lists following the Example and Also See information show the attributes that are available for each function, with links to the descriptions of the corresponding TSP command descriptions. The options for each attribute are the same as the settings for the TSP commands.Limit 1 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_1Limit 1 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_1Limit 1 enable: smu.ATTR_MEAS_LIMIT_ENABLE_1Limit 1 fail: smu.ATTR_MEAS_LIMIT_FAIL_1Limit 1 high value: smu.ATTR_MEAS_LIMIT_HIGH_1Limit 1 low value: smu.ATTR_MEAS_LIMIT_LOW_1Limit 2 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_2Limit 2 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_2Limit 2 enable: smu.ATTR_MEAS_LIMIT_ENABLE_2Limit 2 fail: smu.ATTR_MEAS_LIMIT_FAIL_2Limit 2 high value: smu.ATTR_MEAS_LIMIT_HIGH_2Limit 2 low value: smu.ATTR_MEAS_LIMIT_LOW_2", - "param_info": [ - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuresetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to Details and the tables following the examples", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "" - }, - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_REL_LEVEL, 0.55);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_HIGH_1, 0.64);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_LOW_1, 0.32);smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);", - "description": "Configure the DC Voltage function settings for the relative offset level, limit 1 high value, and limit 1 low value whether or not DC Voltage is the active function.\n--- --Create a configuration list named MyMeasList.\n--- --Store the settings for the DC Voltage function in MyMeasList at index 1.\n" - } - ], - "related_commands": [ - "smu.measure.getattribute()" - ] - } - ] -} \ No newline at end of file diff --git a/data/2461.json b/data/2461.json deleted file mode 100644 index a58c1e8..0000000 --- a/data/2461.json +++ /dev/null @@ -1,17422 +0,0 @@ -{ - "commands": [ - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double-beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - }, - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user-defined string catalog.", - "details": "The catalog provides access for user-defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user-defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key-value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user-defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user-defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user-defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "upgrade.previous()", - "webhelpfile": "14062.htm", - "signature": "upgrade.previous()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns to a previous version of the Model 2461 firmware.", - "details": "This function allows you to revert to an earlier version of the firmware.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument performs the upgrade. An error is returned if an upgrade file is not found.", - "param_info": [], - "usage": [ - "upgrade.previous()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "Upgrading the firmware", - "upgrade.unit()" - ] - }, - { - "name": "upgrade.unit()", - "webhelpfile": "14063.htm", - "signature": "upgrade.unit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function upgrades the Model 2461 firmware.", - "details": "When upgrade.unit() is used, the firmware is only loaded if the version of the firmware is newer than the existing version. If the version is older or at the same revision level, it is not upgraded.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument verifies that the file is a newer version. If the version is older or at the same revision level, it is not upgraded, although it does request a reboot. If it is a newer version, the instrument performs the upgrade. An error event message is returned if no upgrade file is found.", - "param_info": [], - "usage": [ - "upgrade.unit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "upgrade.previous()", - "Upgrading the firmware" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));\u00a0;\u00a0;\u00a0;tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.0000000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.0000000e+00\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP-enabled. The Model 2461 does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP-enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP-enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2461 sends an abort command to the remote device on connection. The Model 2461 also enables TSP prompts on the remote device and event management. The Model 2461 places remote errors and events from the TSP-enabled device in its own event queue and prefaces these events with Remote Error, followed by an event description. Do not manually change either the prompt functionality (localnode.prompts) or show events by changing localnode.showerrors or localnode.showevents on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP-enabled.\n" - } - ], - "related_commands": [ - "localnode.prompts", - "localnode.showevents", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP-Net session.\n--- --\u00a0\n--- --Close the session.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2461 decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the Model 2461 suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The Model 2461 places any remotely generated errors and events into its event queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear as:\n--- --KEITHLEY INSTRUMENTS,MODEL 2461,00000170,1.0.0a\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the Model 2461 pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the Model 2461 reads from a TSP-enabled remote instrument, the Model 2461 removes Test Script Processor (TSP\u00ae) prompts and places any errors or events it receives from the remote instrument into its own event queue. The Model 2461 prefaces events and errors from the remote device with Remote Error, followed by the event number and description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");\u00a0;repeat bytes = tspnet.readavailable(ID) until bytes > 0;\u00a0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that will create data.\n--- --\u00a0\n--- --Wait for data to be available.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands. ", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands will wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP-enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP-enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP-enabled instrument.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The Model 2461 sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma-delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "times = tspnet.tsp.rbtablecopy(testTspdevice,; \"testRemotebuffername.timestamps\", 1, 3);print(times);", - "description": "Copy the specified timestamps table for items 1 through 3, then display the table. Example output:\n--- --01/01/2015 10:10:10.0000013,01/01/2015 10:10:10.0000233,01/01/2015 10:10:10.0000576\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount | integer", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newpath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newpath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "18\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "15009.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts on a remote TSP-Link node. ", - "details": "This command is only applicable to TSP-Link systems. You can use this command to use the remote master node to run a script on the specified node. This function does not run test scripts on the master node; only on the subordinate node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x = 5\") to set x equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "related_commands": [ - "tsplink.group" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. ", - "details": "This function retrieves the value of a global variable from the run-time environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "related_commands": [ - "node[N].setglobal()" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2461 \n" - } - ], - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. ", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "related_commands": [ - "node[N].getglobal()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "15057.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex is set to less than 1 or if endIndex is more than the size of the index, 9.910000e+37 is returned for each value outside the allowed index and an event is generated.If overlapped commands use the specified reading buffers and the commands are not complete (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the readings have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data.The output of printbuffer() is affected by the data format selected by format.data. If you set format.data to format.REAL32 or format.REAL64, you have fewer options for buffer elements. With these formats, the only buffer elements available are readings, relativetimestamps, and extravalues. If you request a buffer element that is not permitted for the selected data format, the instrument returns 9.91e37.You can use the bufferVar attributes that are listed in the following table with the print buffer command. For example, if testData is the buffer, you can use testData.dates attribute to print the date of each reading in the testData buffer.You can use bufferVar.n to retrieve the number of readings in the specified reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "Name of first table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(200);format.data = format.ASCII;format.asciiprecision = 6;trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.readings, testData.units, testData.relativetimestamps);", - "description": "Reset the instrument.\n--- --Set the data format and ASCII precision.\n--- --Use trigger model SimpleLoop to create a 6-count loop with no delays that stores data in the reading buffer testBuffer.\n--- --Start the trigger model, wait for the commands to complete, and output the readings.\n--- --Use of testData.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, testBuffer.n equals 6.\n--- --Example of output data: \n--- --1.10458e-11, Amp DC, 0.00000e+00, 1.19908e-11, Amp DC, 1.01858e-01, 1.19908e-11, Amp DC, 2.03718e-01, 1.20325e-11, Amp DC, 3.05581e-01, 1.20603e-11, Amp DC, 4.07440e-01, 1.20325e-11, Amp DC, 5.09299e-01\n" - }, - { - "example": "for x = 1, testData.n do; printbuffer(x,x,testData, testData.units, testData.relativetimestamps);end;", - "description": "Using the same buffer created in Example 1, output the readings, units and relative timestamps on a separate line for each reading.\n--- --1.10458e-11, Amp DC, 0.00000e+00\n--- --1.19908e-11, Amp DC, 1.01858e-01\n--- --1.19908e-11, Amp DC, 2.03718e-01\n--- --1.20325e-11, Amp DC, 3.05581e-01\n--- --1.20603e-11, Amp DC, 4.07440e-01\n--- --1.20325e-11, Amp DC, 5.09299e-01\n" - } - ], - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.54000000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP-Link node. ", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "2\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. ", - "details": "This command sets the TSP-Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP-Link instrument or tsplink.initialize() is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP-Link node for this instrument to number\u00a03.\n" - } - ], - "related_commands": [ - "tsplink.initialize() ", - "tsplink.state" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. ", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "related_commands": [ - "Triggering using TSP-Link trigger lines", - "tsplink.line[N].state", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP-Link online state. ", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.initialize() or tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "\"online\" | \"offline\"", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP-Link system. If it is online, the output is:\n--- --online\n" - } - ], - "related_commands": [ - "tsplink.initialize()", - "tsplink.node" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP-Link synchronization lines as a digital I/O port. ", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "related_commands": [ - "tsplink.line[N].state" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean | true | false", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that will be used the next time the timer is triggered.If you use the trigger timer with a trigger model, make sure the trigger timer delay is set so that the readings are paced correctly.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (8 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(8 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be >=\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};\u00a0;DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --\u00a0\n--- --Read the delay list on trigger timer\u00a03.\n--- --\u00a0\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event or is enabled as a timer or alarm.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - }, - { - "example": "reset();trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;\u00a0;trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY8);trigger.model.setblock(3, trigger.BLOCK_WAIT, trigger.EVENT_TIMER4);trigger.model.setblock(4, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 20, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the trigger timer 4 stimulus to off.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n--- --\u00a0\n--- --Clear the trigger model.\n--- --Set trigger model block 1 to clear the buffer.\n--- --Set trigger model block 2 to generate the notify 8 event.\n--- --Set trigger model block 3 to wait for the trigger timer 4 to occur.\n--- --Set trigger model block 4 to make a measurement and store it in default buffer 1.\n--- --Set trigger model block 5 to repeat the trigger model 20 times, starting at block 3.\n--- --Start the trigger model.\n--- --Wait until all commands are complete.\n--- --Print the number of entries in default buffer 1.\n--- --\u00a0\n--- --Output:\n--- --20\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified, the script is saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.If you set scriptVar to autoexec, the script is run when the instrument powers up. You must delete the existing autoexec script before saving the new one. Note that performing a system reset does not delete the autoexec script.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB flash drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "related_commands": [ - "Working with scripts" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "smu.measure.func", - "webhelpfile": "25622.htm", - "signature": "", - "command_return": "mFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_CURRENT\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the active measure function.", - "details": "Set this command to the type of measurement you want to make.Reading this command returns the measure function that is presently active.When you select a function, settings for other commands that are related to the function become active. For example, assume that:If you return to the current function, the math function returns to reciprocal. If you then switch from the current function to the voltage function, the math function returns to percent. All attributes that begin with smu.measure. are saved with the active measure function unless otherwise indicated in the command description.If a digitize measurement function is selected, this returns smu.FUNC_NONE. The smu.FUNC_NONE setting is made automatically if you select a function using the smu.digitize.func command or through the options from the front-panel Digitize functions tab.", - "param_info": [ - { - "name": "mFunction", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil|smu.FUNC_NONE nil", - "type": "smumeasurefuncmFunction", - "range": "" - } - ], - "usage": [ - "mFunction = smu.measure.func", - "smu.measure.func = mFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;print(smu.measure.math.format);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.math.format);", - "description": "Sets the instrument to measure voltage and set the math format to percent and enable the math functions.\n--- --Set the instrument to measure resistance and set the math format to reciprocal and enable the math functions.\n--- --Print the math format while the resistance measurement function is selected. The output is:\n--- --smu.MATH_RECIPROCAL\n--- --Change the function to voltage. Print the math format. The output is:\n--- --smu.MATH_PERCENT\n" - } - ], - "related_commands": [ - "smu.digitize.func", - "Source and measure using TSP commands" - ] - }, - { - "name": "buffer.getstats()", - "webhelpfile": "25624.htm", - "signature": "buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "command_return": "statsVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns statistics from a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that was placed in the reading buffer.The instrument automatically updates reading buffer statistics as data is added to the reading buffer.When the reading buffer is configured to fill continuously and overwrite old data with new data, the buffer statistics include the data that was overwritten. To get statistics that do not include data that has been overwritten, define a large buffer size that will accommodate the number of readings you will make. The table returned from this function provides statistics at the time the function is called. Although the instrument continues to update the statistics, the table that is returned is not updated. To get fresh statistics, call this function again.The statsVar parameter contains the values described in the following table.If n equals zero (0), all other values are nil. If n equals 1, stddev is nil because the standard deviation of a sample size of 1 is undefined.Use the following command to get values from statsVar; a table with the following entries in it: n, min, max, mean, and stddev:Use the following commands to print these entries:", - "param_info": [ - { - "name": "statsVar", - "description": "A table that contains the entries for buffer statistics; see Details for information on the entries", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "absStartTime", - "description": "An integer that represents the absolute start time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absStartFractional", - "description": "An integer that represents the portion of the absolute start time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndTime", - "description": "An integer that represents the absolute end time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndFractional", - "description": "An integer that represents the portion of the absolute end time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relStartTime", - "description": "The start time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relEndTime", - "description": "The end time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "overloads": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 12, 0.001, defbuffer1);trigger.model.initiate();waitcomplete();\u00a0;stats = buffer.getstats(defbuffer1);print(stats);", - "description": "Reset the instrument.\n--- --Set up the SimpleLoop trigger-model template to make 12 readings with a 0.001\u00a0s delay. Readings are stored in defbuffer1.\n--- --Start the trigger model.\n--- --Assign the name stats to the table.\n--- --Get statistics for the default reading buffer named defbuffer1.\n--- --Example output:\n--- --[\"min\"]={[\"seconds\"]=1561123956, [\"fractionalseconds\"]=0.010184587, [\"timestamp\"]=1561123956, [\"reading\"]=8.4974199416e-05}, [\"mean\"]=0.000132948335, [\"stddev\"]=4.4270141937e-05, [\"max\"]={[\"seconds\"]=1561123955, [\"fractionalseconds\"]=0.833083981, [\"timestamp\"]=1561123955.8, [\"reading\"]=0.0002192359033}, [\"n\"]=12\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.model.abort()", - "webhelpfile": "25628.htm", - "signature": "trigger.model.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stops all trigger model commands on the instrument.", - "details": "When this command is received, the instrument stops the trigger model.", - "param_info": [ - { - "name": "trigger.model.abort()", - "description": "Terminates all commands related to the trigger model on the instrument.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.abort();", - "description": "Terminates all commands related to the trigger model on the instrument.\n" - } - ], - "related_commands": [ - "Effect of GPIB line events on Model 2461", - "Aborting the trigger model" - ] - }, - { - "name": "buffer.make()", - "webhelpfile": "25629.htm", - "signature": "buffer.make(bufferSize, style)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a user-defined reading buffer.", - "details": "You cannot assign user-defined reading buffers the name defbuffer1 or defbuffer2. In addition, the buffer name must not already exist as a global variable, a local variable, table, or array.If you create a reading buffer that has the same name as an existing user-defined buffer, the existing buffer is overwritten by the new buffer. Any data in the existing buffer is lost.When you create a reading buffer, it becomes the active buffer. If you create two reading buffers, the last one you create becomes the active buffer.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.The default fill mode of a user-defined buffer is once. You can change it to continuous later.Once the buffer style is selected, it cannot be changed.Once you store the first reading in a compact buffer, you cannot change certain measurement settings, including range, display digits, and units; you must clear the buffer first.Not all remote commands are compatible with the compact, writable, and full writable buffer styles. Check the Details section of the command descriptions before using them with any of these buffer styles.Writable reading buffers are used to bring external data into the instrument. You cannot assign them to collect data from the instrument.You can change the buffer capacity for an existing buffer through the front panel or by using the bufferVar.capacity command.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferSize", - "description": "The maximum number of readings that can be stored in bufferVar; minimum is\u00a010; 0 to maximize buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "style", - "description": "The type of reading buffer to create", - "enum": "buffer.STYLE_COMPACT nil|buffer.STYLE_STANDARD nil|buffer.STYLE_FULL nil|buffer.STYLE_WRITABLE nil|buffer.STYLE_WRITABLE_FULL nil", - "type": "buffermakestyle", - "range": "" - } - ], - "usage": [ - "bufferVar = buffer.make(bufferSize)", - "bufferVar = buffer.make(bufferSize, style)" - ], - "overloads": [ - "bufferVar = buffer.make(bufferSize)" - ], - "examples": [ - { - "example": "capTest2\u00a0= buffer.make(200, buffer.STYLE_FULL);", - "description": "Creates a 200-element reading buffer that stores readings with full accuracy named capTest2.\n" - } - ], - "related_commands": [ - "bufferVar.capacity", - "bufferVar.fillmode", - "buffer.write.format()", - "buffer.write.reading()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "25630.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the specified reading buffer.", - "details": "You can call this command to return the number of readings stored in the specified reading buffer.You can use the bufferVar.n attribute in other commands. For example, to print all the readings in a buffer, use the following command:Where bufferVar is the name of the buffer to use.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the reading buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(100);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.n);print(defbuffer1.n);print(defbuffer2.n);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the number of readings in testData.\n--- --Output:\n--- --3\n--- --Print the number of readings in defbuffer1.\n--- --Example output:\n--- --0\n--- --Print the number of readings in defbuffer2.\n--- --Example output:\n--- --0\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "timer.gettime()", - "webhelpfile": "25635.htm", - "signature": "timer.gettime()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function measures the elapsed time since the timer was last cleared.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.cleartime()" - ] - }, - { - "name": "timer.cleartime()", - "webhelpfile": "25636.htm", - "signature": "timer.cleartime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "dataqueue.clear()dataqueue.add(35)timer.cleartime()delay(0.5)dt = timer.gettime()print(\"Delay time was \" .. dt)print(dataqueue.next())", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.cleartime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.gettime()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "25637.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending command triggers.", - "details": "A command trigger indicates if a trigger event has been detected over a command interface since the last trigger.wait() command was sent. Command triggers are generated by:trigger.clear() clears the command triggers and discards the history of trigger events.", - "param_info": [ - { - "name": "*TRGprint(trigger.wait(1))trigger.clear()print(trigger.wait(1))", - "description": "Generate a trigger event.Check if there are any pending trigger events. Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "*TRG;print(trigger.wait(1));trigger.clear();print(trigger.wait(1));", - "description": "Generate a trigger event.\n--- --Check if there are any pending trigger events. \n--- --Output: true\n--- --Clear any pending command triggers.\n--- --Check if there are any pending trigger events.\n--- --Output: false\n" - } - ], - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "25639.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "A trigger was detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "bufferVar.formattedreadings", - "webhelpfile": "25640.htm", - "signature": "bufferVar.formattedreadings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the stored readings shown as numbers with units and prefixes.", - "details": "This read-only attribute is an array that contains the stored readings. The readings are shown as numbers with prefixes before the units symbol.", - "param_info": [ - { - "name": "reading", - "description": "Buffer reading formatted with numbers and prefixes with units for element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.formattedreadings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.formattedreadings[1]);printbuffer(1, testData.n, testData.formattedreadings);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading.\n--- --Example output:\n--- --+00.0028 nA\n--- --Print all readings in the reading buffer.\n--- --Example output:\n--- --+00.0028 nA, +00.0039 nA, +00.0040 nA\n--- --\u00a0\n" - } - ], - "related_commands": [ - "bufferVar.readings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.units", - "webhelpfile": "25641.htm", - "signature": "bufferVar.units[N]", - "command_return": "readingUnit", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "details": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "param_info": [ - { - "name": "readingUnit", - "description": "Volt DC", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingUnit = bufferVar.units[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);testData.fillmode = buffer.FILL_CONTINUOUS;smu.measure.func = smu.FUNC_DC_CURRENT;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the buffer to fill continuously.\n--- --Set the measure function to current.\n--- --Make three readings.\n--- --Print the units for the readings.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the measure function to voltage.\n--- --Make three readings.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.saveappend()", - "webhelpfile": "25642.htm", - "signature": "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function appends data from the reading buffer to a file on the USB flash drive.", - "details": "If the file you specify does not exist on the USB flash drive, this command creates the file.For options that save more than one item of time information, each item is comma-delimited. For example, the default format is date, time, and fractional seconds for each reading.The file extension .csv is appended to the file name if necessary. Any file extension other than .csv generates an error.The index column entry in the .csv file starts at 1 for each append operation.Examples of valid destination file names:Invalid destination file name examples:\u2014 The period is not followed by csv.\u2014 The only allowed extension is .csv. If .csv is not assigned, it is automatically added.", - "param_info": [ - { - "name": "bufferVar", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Indicates how date and time information from the buffer is saved in the file on the USB flash drive; the options are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersaveappendtimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)", - "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)" - ], - "overloads": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)" - ], - "examples": [ - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myData.csv\");", - "description": "Append reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Append readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash\u00a0drive.\n" - }, - { - "example": "reset();if file.usbdriveexists() == 1 then; testDir = \"TestData11\";-- Create a directory on the USB drive for the data.; file.mkdir(testDir);-- Build the full file and path.; fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";-- Open the file where the data will be stored.; fileNumber = file.open(fileName, file.MODE_WRITE);-- Write the string data to a file.; file.write(fileNumber, \"Tested to Company Standard ABC.101\\n\");-- Write the header separator to a file.; file.write(fileNumber, \"====================================================================\\n\");-- Write the string data to a file.; file.write(fileNumber, \"\\t1. Connect HI/LO to respective DUT terminals.\\n\"); file.write(fileNumber, \"\\t2. Set power supply to 5 VDC @ 1 A.\\n\"); file.write(fileNumber, \"\\t3. Wait 30 minutes.\\n\"); file.write(fileNumber, \"\\t4. Capture 100 readings and analyze data.\\n\\n\\n\");-- Write buffering data to a file.; file.flush(fileNumber);-- Close the data file.; file.close(fileNumber);end;-- Fix the range to 10 V.;smu.measure.range = 10.0;-- Set the measurement count to 100.;smu.measure.count = 100;-- Set up reading buffers.;-- Ensure the default measurement buffer size matches the count.;defbuffer1.capacity = smu.measure.count;smu.measure.read();buffer.saveappend(defbuffer1, fileName);", - "description": "Write string data to a file with information about a test file.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.save()" - ] - }, - { - "name": "smu.measure.math.enable", - "webhelpfile": "25644.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables math operations on measurements for the selected measurement function.", - "details": "When this command is set to on, the math operation specified by the math format command is performed before completing a measurement.", - "param_info": [ - { - "name": "value", - "description": "The math enable setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasuremathenablevalue", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathenablefunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.enable", - "smu.measure.math.enable = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_ENABLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;", - "description": "When voltage measurements are made, the math format is enabled and set to percent.\n" - } - ], - "related_commands": [ - "smu.measure.math.format" - ] - }, - { - "name": "smu.measure.rel.acquire()", - "webhelpfile": "25645.htm", - "signature": "smu.measure.rel.acquire()", - "command_return": "relativeValue", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function acquires a measurement and stores it as the relative offset value.", - "details": "This command triggers the instrument to make a new measurement for the selected function. This measurement is then stored as the new relative offset level.When you send this command, the instrument does not apply any math, limit test, or filter settings to the measurement, even if they are set. It is a measurement that is made as if these settings are disabled.If an error event occurs during the measurement, nil is returned and the relative offset level remains at the last valid setting.You must change to the function for which you want to acquire a value before sending this command.The instrument must have relative offset enabled to use the acquired relative offset value.After executing this command, you can use the smu.measure.rel.level attribute to see the last relative level value that was acquired or that was set.", - "param_info": [ - { - "name": "relativeValue", - "description": "The internal measurement acquired for the relative offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "relativeValue = smu.measure.rel.acquire()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.enable", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.limit[Y].autoclear", - "webhelpfile": "25682.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the test result for limit Y should be cleared automatically or not.", - "details": "When auto clear is set to on, limit conditions are cleared automatically after each measurement. If you are making a series of measurements, the instrument shows the limit test result of the last measurement for the pass or fail indication for the limit.If you want to know if any of a series of measurements failed the limit, set the auto clear setting to off. When this is set to off, a failed indication is not cleared automatically. It remains set until it is cleared with the clear command.The auto clear setting affects both the high and low limits.", - "param_info": [ - { - "name": "value", - "description": "The auto clear setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitautoclearvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitautoclearfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].autoclear = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[1].autoclear = smu.ON;", - "description": "Turns on autoclear for limit 1 when measuring DC current.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].clear()" - ] - }, - { - "name": "smu.measure.limit[Y].clear()", - "webhelpfile": "25683.htm", - "signature": "smu.measure.limit[Y].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the results of the limit test defined by Y for the selected measurement function.", - "details": "Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared.To avoid the need to manually clear the test results for a limit, turn the auto clear option on.", - "param_info": [ - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.limit[Y].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[2].clear();", - "description": "Clears the test result for the high and low limit 2 for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear" - ] - }, - { - "name": "smu.measure.limit[Y].fail", - "webhelpfile": "25684.htm", - "signature": "", - "command_return": "result", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute queries the results of a limit test.", - "details": "This command queries the result of a limit test for the selected measurement function.The response message indicates if the limit test passed or how it failed (on the high or low limit).If autoclear is set to off, reading the results of a limit test does not clear the fail indication of the test. To clear a failure, send the clear command. To automatically clear the results, set auto clear on.If auto clear is set to on and you are making a series of measurements, the last measurement limit determines the fail indication for the limit. If auto clear is turned off, the results return a test fail if any of one of the readings failed.To use this attribute, you must set the limit state to on.If the readings are stored in a reading buffer, you can use the bufferVar.statuses command to see the results.This example enables limits 1 and 2 for voltage, measurements. Limit 1 is checking for readings to be between 3 and 5 V, while limit\u00a02 is checking for the readings to be between 1 and 7 V. The auto clear feature is disabled, so if any reading is outside these limits, the corresponding fail is 1. Therefore, if any one of the fails is 1, analyze the reading buffer data to find out which reading failed the limits.", - "param_info": [ - { - "name": "result", - "description": "The results of the limit test for limit Y", - "enum": "smu.FAIL_NONE nil|smu.FAIL_HIGH nil|smu.FAIL_LOW nil|smu.FAIL_BOTH nil", - "type": "smumeasurelimitfailresult", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitfailfunction", - "range": "" - } - ], - "usage": [ - "result = smu.measure.limit[Y].fail", - "result = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_FAIL_Y)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();-- set the instrument source current;smu.source.func = smu.FUNC_DC_CURRENT;-- set the instrument to measure voltage;smu.measure.func = smu.FUNC_DC_VOLTAGE;-- set the range to 10 V;smu.measure.range = 10;-- set the nplc to 0.1;smu.measure.nplc = 0.1;-- disable auto clearing for limit 1;smu.measure.limit[1].autoclear = smu.OFF;-- set high limit on 1 to fail if reading exceeds 5 V;smu.measure.limit[1].high.value = 5;-- set low limit on 1 to fail if reading is less than 3 V;smu.measure.limit[1].low.value = 3;--- set the beeper to sound if the reading exceeds the limits for limit 1;smu.measure.limit[1].audible = smu.AUDIBLE_FAIL;-- enable limit 1 checking for voltage measurements;smu.measure.limit[1].enable = smu.ON;-- disable auto clearing for limit 2;smu.measure.limit[2].autoclear = smu.OFF;-- set high limit on 2 to fail if reading exceeds 7 V;smu.measure.limit[2].high.value = 7;-- set low limit on 2 to fail if reading is less than 1 V;smu.measure.limit[2].low.value = 1;-- enable limit 2 checking for voltage measurements;smu.measure.limit[2].enable = smu.ON;-- set the measure count to 50;smu.measure.count = 50;-- create a reading buffer that can store 100 readings;LimitBuffer = buffer.make(100);-- make 50 readings and store them in LimitBuffer;smu.measure.read(LimitBuffer);-- Check if any of the 50 readings were outside of the limits;print(\"limit 1 results = \" .. smu.measure.limit[1].fail);print(\"limit 2 results = \" .. smu.measure.limit[2].fail);-- clear limit 1 conditions;smu.measure.limit[1].clear();-- clear limit 2 conditions;smu.measure.limit[2].clear();", - "description": "Example output that shows all readings are within limit values (all readings between 3 V and 5 V):\n--- --limit 1 results = smu.FAIL_NONE\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 high values (a 6\u00a0V reading would cause this condition or a reading greater than 5 V but less than 7 V):\n--- --limit 1 results = smu.FAIL_HIGH\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 and 2 low values (a 0.5 V reading would cause this condition or a reading less than 1\u00a0V):\n--- --limit 1 results = smu.FAIL_LOW\n--- --limit 2 results = smu.FAIL_LOW\n" - } - ], - "related_commands": [ - "bufferVar.statuses", - "Limit testing and binning", - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].high.value", - "webhelpfile": "25685.htm", - "signature": "", - "command_return": "highLimit", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the upper limit for a limit test.", - "details": "This command sets the high limit for the limit Y test for the selected measurement function. When limit Y testing is enabled, the instrument generates a fail indication when the measurement value is more than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "highLimit", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)", - "enum": "", - "type": "number", - "range": "(-9.99999e+11 to +9.99999e+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimithighvaluefunction", - "range": "" - } - ], - "usage": [ - "highLimit = smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].high.value = highLimit", - "highLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_HIGH_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_HIGH_Y, highLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "highLimit;", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].low.value", - "webhelpfile": "25686.htm", - "signature": "", - "command_return": "lowLimit", - "type": "Attribute (RW)", - "default_value": "-1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the lower limit for limit tests.", - "details": "This command sets the lower limit for the limit Y test for the selected measure function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "lowLimit", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)", - "enum": "", - "type": "number", - "range": "(-9.99999E+11 to 9.99999E+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitlowvaluefunction", - "range": "" - } - ], - "usage": [ - "lowLimit = smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].low.value = lowLimit", - "lowLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_LOW_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_LOW_Y, lowLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "lowLimit;", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.math.format", - "webhelpfile": "25687.htm", - "signature": "", - "command_return": "operation", - "type": "Attribute (RW)", - "default_value": "smu.MATH_PERCENT\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which math operation is performed on measurements when math operations are enabled.", - "details": "This specifies which math operation is performed on measurements for the selected measurement function.You can choose one of the following math operations:Math calculations are applied to the input signal after relative offset and before limit tests.", - "param_info": [ - { - "name": "operation", - "description": "Math operation to be performed on measurements", - "enum": "smu.MATH_MXB nil|smu.MATH_PERCENT nil|smu.MATH_RECIPROCAL nil", - "type": "smumeasuremathformatoperation", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathformatfunction", - "range": "" - } - ], - "usage": [ - "operation = smu.measure.math.format", - "smu.measure.math.format = operation", - "operation = smu.measure.getattribute(function, ATTR_MEAS_MATH_FORMAT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_FORMAT, operation)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;", - "description": "Enables the reciprocal math operation on voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.mfactor", - "smu.measure.math.percent" - ] - }, - { - "name": "smu.measure.read()", - "webhelpfile": "25688.htm", - "signature": "smu.measure.read(bufferName)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes measurements, places them in a reading buffer, and returns the last reading.", - "details": "This function makes a measurement using the present function setting, stores the reading in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed. You can also use the trigger model Simple Loop.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is defined, it defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading = smu.measure.read()", - "reading = smu.measure.read(bufferName)" - ], - "overloads": [ - "reading = smu.measure.read()" - ], - "examples": [ - { - "example": "voltMeasBuffer = buffer.make(10000);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.read(voltMeasBuffer));", - "description": "Create a buffer named voltMeasBuffer. Set the instrument to measure voltage.\n--- --Make a measurement that is stored in the voltMeasBuffer and is also printed.\n" - } - ], - "related_commands": [ - "buffer.make()", - "smu.measure.count", - "smu.measure.unit", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.measure.configlist.create()", - "webhelpfile": "25691.htm", - "signature": "smu.measure.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty measure configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");", - "description": "Create a measure configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.catalog()", - "smu.measure.configlist.delete()", - "smu.measure.configlist.query()", - "smu.measure.configlist.recall()", - "smu.measure.configlist.size()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.store()", - "webhelpfile": "25693.htm", - "signature": "smu.source.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active source settings into the named configuration list.", - "details": "Use this command to store the active source settings to a configuration index in a configuration list. If the index is defined, the configuration list is stored in that index. If the index is not defined, the configuration index is appended to the end of the list. If a configuration index already exists for the specified index, the new configuration overwrites the existing configuration index.Refer to Settings stored in a source configuration index for information about the settings this command stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.store(listName)", - "smu.source.configlist.store(listName, index)" - ], - "overloads": [ - "smu.source.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.store(\"MyConfigList\");", - "description": "Store the active settings of the instrument to the source configuration list MyConfigList. Settings are saved at the end of the list since no index parameter is specified.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.configlist.catalog()", - "webhelpfile": "25695.htm", - "signature": "smu.source.configlist.catalog()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one source configuration list.", - "details": "You can use this command to retrieve the names of source configuration lists that are stored in the instrument.This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no source configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "print(smu.source.configlist.catalog())", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.catalog());", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.create()", - "webhelpfile": "25696.htm", - "signature": "smu.source.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty source configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. If you want to save a configuration list through a power cycle, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;\u00a0;smu.source.configlist.create(\"MyScrList\");\u00a0;print(smu.source.configlist.catalog());\u00a0;print(smu.source.configlist.catalog());\u00a0;\u00a0;\u00a0;smu.source.configlist.store(\"MyScrList\");smu.source.configlist.store(\"MyScrList\");print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Create a source configuration list named MyScrLst.\n--- --Print the name of one configuration list stored in volatile memory.\n--- --Output:\n--- --MyScrList\n--- --Print the name of one configuration list.\n--- --Output:\n--- --nil\n--- --Nil indicates that no more configuration lists are stored.\n--- --Store a configuration index in MyScrList.\n--- --Store a configuration index in MyScrList.\n--- --Print the number of configuration indexes in MyScrList.\n--- --Output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.delete()", - "webhelpfile": "25697.htm", - "signature": "smu.source.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a source configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.delete(listName)", - "smu.source.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.source.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.delete(\"mySourceList\");", - "description": "Deletes a configuration list named mySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.query()", - "webhelpfile": "25698.htm", - "signature": "smu.source.configlist.query(listName, index, fieldSeparator)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command can only return data for one configuration index. To get data for additional configuration indexes, resend the command and specify different configuration indexes. Refer to Settings stored in a source configuration list for a complete list of source settings that the instrument stores in a source configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list; the default is the first index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.query(listName, index)", - "smu.source.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "smu.source.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(smu.source.configlist.query(\"MyScrList\", 2));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.size()", - "webhelpfile": "25700.htm", - "signature": "smu.source.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of configuration indexes in a source configuration list.", - "details": "The size of the list is equal to the number of configuration indexes in a configuration list.", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total quantity of indexes stored in the specified source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.source.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Determine the number of configuration indexes in a source configuration list named MyScrList.\n--- --Example output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "eventlog.save()", - "webhelpfile": "25702.htm", - "signature": "eventlog.save(filename, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the event log to a file on a USB flash drive.", - "details": "This command saves all event log entries to a USB flash drive.If you do not define an event type, the instrument saves all event log entries.The extension .csv is automatically added to the file name.", - "param_info": [ - { - "name": "filename", - "description": "A string that represents the name of the file to be saved", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsaveeventType", - "range": "" - } - ], - "usage": [ - "eventlog.save(filename)", - "eventlog.save(filename, eventType)" - ], - "overloads": [ - "eventlog.save(filename)" - ], - "examples": [ - { - "example": "eventlog.save(\"/usb1/WarningsApril\", eventlog.SEV_WARN);", - "description": "Save warning messages to a .csv file on a USB flash drive.\n" - } - ], - "related_commands": [ - "eventlog.next()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "25706.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This command allows you to change or view how many readings a buffer can store. Changing the size of a buffer will cause any existing data in the buffer to be lost.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store; set to 0 to maximize the buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity", - "bufferVar.capacity = bufferCapacity" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(500);capTest = buffer.make(300);bufferCapacity = capTest.capacity;\u00a0;print(bufferCapacity);\u00a0;\u00a0;print(testData.capacity);\u00a0;\u00a0;testData.capacity = 600;print(testData.capacity);print(defbuffer1.capacity);", - "description": "Create two user-defined reading buffers: testData and capTest.\n--- --\u00a0\n--- --Create a variable called bufferCapacity to hold the capacity of the capTest buffer.\n--- --Print bufferCapacity.\n--- --Output:\n--- --300\n--- --Print the capacity of testData.\n--- --Output:\n--- --500\n--- --Changes the capacity of testData to 600.\n--- --Print the capacity of testData.\n--- --Output:\n--- --600\n--- --Print the capacity of the default buffer defbuffer1.\n--- --Output:\n--- --10000\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourceunits", - "webhelpfile": "25707.htm", - "signature": "bufferVar.sourceunits[N]", - "command_return": "readingUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of measure of the source.", - "details": "The attribute is an array (a Lua table) of strings indicating the units of measure at the time of the reading.", - "param_info": [ - { - "name": "readingUnits", - "description": "The units of measure of the source", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "readingUnits = bufferVar.sourceunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;testData.fillmode = buffer.FILL_CONTINUOUS;trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_CURRENT;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);smu.source.output = smu.OFF;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source output to ON.\n--- --Set the buffer to fill continuously.\n--- --Set the source function to current.\n--- --Take three readings.\n--- --Print the units for the first three readings in the buffer.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the source function to voltage.\n--- --Take three readings.\n--- --Print the units for the readings in the buffer.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "bufferVar.sourceunits", - "bufferVar.sourcevalues", - "bufferVar.statuses" - ] - }, - { - "name": "bufferVar.relativetimestamps", - "webhelpfile": "25712.htm", - "signature": "bufferVar.relativetimestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamps, in seconds, when each reading occurred, relative to the timestamp of the first entry in the reading buffer.", - "details": "This read-only attribute is an array of timestamps, in seconds, of when each reading occurred relative to the timestamp of the first entry in the reading buffer. These timestamps are equal to the time that has lapsed for each reading since the first reading was stored in the buffer. Therefore, the relative timestamp for the first entry number in the reading buffer equals 0.", - "param_info": [ - { - "name": "timestamp", - "description": "The timestamp, in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timestamp = bufferVar.relativetimestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.relativetimestamps[1]);printbuffer(1, 3, testData.relativetimestamps);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --\u00a0\n--- --Print the relative timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0\n--- --Print the relative timestamp for the reading 1 through 3 in the buffer.\n--- --Example output:\n--- --0, 0.383541, 0.772005\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.seconds", - "webhelpfile": "25713.htm", - "signature": "bufferVar.seconds[N]", - "command_return": "nonFracSeconds", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp of a reading in seconds, in UTC format.", - "details": "This attribute contains the nonfractional seconds portion of the timestamp when the reading was stored in Coordinated Universal Time (UTC) format.The nonfractional seconds portion of the timestamp gives the lowest resolution down to 1 second. To access additional resolution of a timestamp, see bufferVar.fractionalseconds.", - "param_info": [ - { - "name": "nonFracSeconds", - "description": "The nonfractional seconds portion of the timestamp when the reading was stored", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "nonFracSeconds = bufferVar.seconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 6, testData.seconds);", - "description": "Create a reading buffer named testData, configure the instrument to make six measurements, and store the readings in the buffer.\n--- --Print the seconds portion for readings 1 to 6 in testData. \n--- --Example output:\n--- --1362261492, 1362261492, 1362261493, 1362261493, 1362261493, 1362261494\n" - } - ], - "related_commands": [ - "bufferVar.fractionalseconds", - "bufferVar.relativetimestamps" - ] - }, - { - "name": "bufferVar.times", - "webhelpfile": "25715.htm", - "signature": "bufferVar.times[N]", - "command_return": "readingTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the time when the instrument made the reading.", - "details": "", - "param_info": [ - { - "name": "readingTime", - "description": "The time of the reading in hours, minutes, and seconds", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTime = bufferVar.times[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.times[1]);printbuffer(1, 3, testData.times);", - "description": "This example creates a reading buffer named testData and makes three measurements.\n--- --The print() command outputs the time of the first reading. \n--- --Output:\n--- --23:09:43\n--- --The printbuffer() command outputs the time of readings 1 to 3 in the reading buffer. \n--- --Output:\n--- --23:09:43, 23:09:43, 23:09:43\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "25716.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "readingTimestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "This attribute contains the timestamps (date, hours, minutes, seconds, and fractional seconds) of readings stored in the reading buffer.", - "param_info": [ - { - "name": "readingTimestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "string[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTimestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.timestamps[1]);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Output:\n--- --03/01/2018 14:46:07.714614838\n" - }, - { - "example": "for x = 1, 3 do printbuffer(x, x, testData.timestamps) end;", - "description": "For the buffer created in Example 1, print the timestamps for the readings.\n--- --Output:\n--- --03/01/2018 14:46:07.71461483803/01/2018 14:46:08.10046883803/01/2018 14:46:08.487631838\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.readingformat", - "webhelpfile": "25719.htm", - "signature": "", - "command_return": "format", - "type": "Attribute (RW)", - "default_value": "display.FORMAT_PREFIX\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the format that is used to display measurement readings on the front-panel display of the instrument.", - "details": "This setting persists through reset() and power cycles.When Prefix is selected, prefixes are added to the units symbol, such as k (kilo) or m (milli). When Exponent is selected, exponents are used instead of prefixes. When the prefix option is selected, very large or very small numbers may be displayed with exponents.", - "param_info": [ - { - "name": "format", - "description": "Use exponent format", - "enum": "display.FORMAT_EXPONENT nil|display.FORMAT_PREFIX nil", - "type": "displayreadingformatformat", - "range": "" - } - ], - "usage": [ - "format = display.readingformat", - "display.readingformat = format" - ], - "overloads": [], - "examples": [ - { - "example": "display.readingformat = display.FORMAT_EXPONENT;", - "description": "Change front-panel display to show readings in exponential format.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "25722.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function defines the text that is displayed on the front-panel USER swipe screen.", - "details": "This command defines text messages for the USER swipe screen.If you enter too many characters, the instrument displays a warning event and shortens the message to fit.When the instrument is reset, the user test is removed and the USER swipe screen is hidden until another message is defined.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "displayArea", - "description": "display.TEXT1 display.TEXT2", - "enum": "display.TEXT1 nil|display.TEXT2 nil", - "type": "displaysettextdisplayArea", - "range": "" - }, - { - "name": "text", - "description": "String that contains the message for the top line of the USER swipe screen (up to 20 characters)", - "enum": "", - "type": "string", - "range": "(up to 20 characters)" - } - ], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"A122 \\185 A123\");display.settext(display.TEXT2, \"Results in \\018\");", - "description": "Clear the USER swipe screen.\n--- --Display the USER swipe screen.\n--- --Set the first line to read \"A122 \u0394 A123\" and the second line to display \"\"Results in \u03a9\":\n--- --\n" - } - ], - "related_commands": [ - "display.clear()", - "display.changescreen()" - ] - }, - { - "name": "file.mkdir()", - "webhelpfile": "25723.htm", - "signature": "file.mkdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a directory at the specified path on the USB flash drive.", - "details": "The directory path must be absolute. The name of the directory must not already exist on the flash drive.", - "param_info": [ - { - "name": "path", - "description": "A string that contains the path of the directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.mkdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "file.mkdir(\"TestData\");", - "description": "Create a new directory named TestData.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.open()", - "webhelpfile": "25724.htm", - "signature": "file.open(fileName, accessType)", - "command_return": "fileNumber", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file on the USB flash drive for later reference.", - "details": "The path to the file to open must be absolute.The root folder of the USB flash drive has the following absolute path:", - "param_info": [ - { - "name": "fileNumber", - "description": "A number identifying the open file that you use with other file commands to write, read, flush, or close the file after opening", - "enum": "", - "type": "file_object", - "range": "" - }, - { - "name": "fileName", - "description": "A string that contains the file name to open, including the full path of file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "accessType", - "description": "The type of action to do", - "enum": "file.MODE_APPEND nil|file.MODE_READ nil|file.MODE_WRITE nil", - "type": "fileopenaccessType", - "range": "" - } - ], - "usage": [ - "fileNumber = file.open(fileName, accessType)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.ipconfig()", - "webhelpfile": "25725.htm", - "signature": "lan.ipconfig()", - "command_return": "method, ipV4Address, subnetMask, gateway", - "type": "Function", - "default_value": "lan.MODE_AUTO\n", - "tsp_link": "No\n", - "description": "This function specifies the LAN configuration for the instrument.", - "details": "This command specifies how the LAN IP address and other LAN settings are assigned. If automatic configuration is selected, the instrument automatically determines the LAN information. When method is automatic, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, an error occurs.If manual is selected, you must define the IP address. You can also assign a subnet mask, and default gateway. The IP address, subnet mask, and default gateway must be formatted in four groups of numbers, each separated by a decimal. If you do not specify a subnet mask or default gateway, the previous settings are used.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.MODE_AUTO nil|lan.MODE_MANUAL nil", - "type": "lanipconfigmethod", - "range": "" - }, - { - "name": "ipV4Address", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "subnetMask", - "description": "The LAN subnet mask; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "gateway", - "description": "The LAN default gateway; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "method, ipV4Address, subnetMask, gateway = lan.ipconfig()", - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "overloads": [ - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "examples": [ - { - "example": "lan.ipconfig(lan.MODE_AUTO);print(lan.ipconfig());lan.ipconfig(lan.MODE_MANUAL, \"192.168.0.7\", \"255.255.240.0\", \"192.168.0.3\");print(lan.ipconfig());", - "description": "Set the IP configuration method to automatic. Request the IP configuration. Example output:\n--- --lan.MODE_AUTO 134.63.78.136\u00a0\u00a0 255.255.254.0\u00a0\u00a0 134.63.78.1\n--- --Set the IP configuration method to manual. Request the IP configuration. Output:\n--- --lan.MODE_MANUAL 192.168.0.7\u00a0\u00a0\u00a0 255.255.240.0\u00a0 192.168.0.3\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.settime()", - "webhelpfile": "25726.htm", - "signature": "localnode.settime(year, month, day, hour, minute, second)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the date and time of the instrument.", - "details": "Internally, the instrument bases time in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).When called without a parameter (the first form), the function returns the current time.", - "param_info": [ - { - "name": "year", - "description": "Year; must be more than 1970", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "month", - "description": "Month (1 to 12)", - "enum": "", - "type": "number", - "range": "(1 to 12)" - }, - { - "name": "day", - "description": "Day (1 to 31)", - "enum": "", - "type": "number", - "range": "(1 to 31)" - }, - { - "name": "hour", - "description": "Hour in 24-hour time format (0 to 23)", - "enum": "", - "type": "number", - "range": "(0 to 23)" - }, - { - "name": "minute", - "description": "Minute (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - }, - { - "name": "second", - "description": "Second (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - } - ], - "usage": [ - "localnode.settime()", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "overloads": [ - "localnode.settime()", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "examples": [ - { - "example": "localnode.settime(2017, 12, 5, 15, 48, 20);print(localnode.settime());", - "description": "Sets the date and time to December 5, 2017 at 3:48:20\u00a0pm and verifies the time.\n--- --Output:\n--- --Tue Dec 5 15:48:20 2017\n" - }, - { - "example": "systemTime = os.time({year = 2018,; month = 3,; day = 31,; hour = 14,; min = 25});localnode.settime(systemTime);print(os.date('%c', gettime()));", - "description": "Sets the date and time to Mar 31, 2018 at 2:25\u00a0pm.\n--- --Output:\n--- --Sat Mar 31 14:25:00 2018\n" - } - ], - "related_commands": [ - "localnode.gettime()" - ] - }, - { - "name": "smu.interlock.tripped", - "webhelpfile": "25729.htm", - "signature": "", - "command_return": "interlockStatus", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates that the interlock has been tripped.", - "details": "This command gives you the status of the interlock. When the safety interlock signal is asserted, all voltage ranges of the instrument are available. However, when the safety interlock signal is not asserted, the 100\u00a0V range is hardware limited to a nominal output of less than \u00b142\u00a0V.When the interlock is not asserted:", - "param_info": [ - { - "name": "interlockStatus", - "description": "The status of the interlock", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlocktrippedinterlockStatus", - "range": "" - } - ], - "usage": [ - "interlockStatus = smu.interlock.tripped" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.interlock.tripped);", - "description": "If the interlock is not asserted, returns smu.OFF.\n--- --If the interlock is asserted, returns smu.ON.\n" - } - ], - "related_commands": [ - "smu.interlock.enable" - ] - }, - { - "name": "smu.measure.sense", - "webhelpfile": "25730.htm", - "signature": "", - "command_return": "sensing", - "type": "Attribute (RW)", - "default_value": "smu.SENSE_2WIRE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects local (2-wire) or remote (4-wire) sensing.", - "details": "This command determines if 2-wire (local) or 4-wire (remote) sensing is used.When you use 4-wire sensing, voltages are measured at the device under test (DUT). For the source voltage, if the sensed voltage is lower than the programmed amplitude, the voltage source increases the voltage until the sensed voltage is the same as the programmed amplitude. This compensates for IR drop in the output test leads.Using 4-wire sensing with voltage measurements eliminates any voltage drops that may be in the test leads between the Model 2461 and the DUT.When you are using 2-wire sensing, voltage is measured at the output connectors.When you are measuring resistance, you can enable 4-wire sensing to make 4-wire resistance measurements.When the output is off, 4-wire sensing is disabled and the instrument uses 2-wire sense, regardless of the sense setting. When the output is on, the selected sense setting is used.If the output is on when you change the sense setting, the output is turned off. ", - "param_info": [ - { - "name": "sensing", - "description": "Two-wire sensing", - "enum": "smu.SENSE_2WIRE nil|smu.SENSE_4WIRE nil", - "type": "smumeasuresensesensing", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuresensefunction", - "range": "" - } - ], - "usage": [ - "sensing = smu.measure.sense", - "smu.measure.sense = sensing", - "sensing = smu.measure.getattribute(function, ATTR_MEAS_SENSE)", - "smu.measure.setattribute(function, ATTR_MEAS_SENSE, sensing)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;", - "description": "Set the measurement function to resistance.\n--- --Set the sense to 4-wire remote.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.terminals", - "webhelpfile": "25737.htm", - "signature": "", - "command_return": "terminals", - "type": "Attribute (RW)", - "default_value": "smu.TERMINALS_FRONT\n", - "tsp_link": "Yes\n", - "description": "This attribute describes which set of input and output terminals the instrument is using.", - "details": "This command selects which set of input and output terminals the instrument uses. You can select front panel or rear panel terminals.If the output is on when you change from one set of terminals to the other, the output is turned off.This command replaces the smu.measure.terminals command, which is deprecated.", - "param_info": [ - { - "name": "terminals", - "description": "Use the front-panel input and output terminals", - "enum": "smu.TERMINALS_FRONT nil|smu.TERMINALS_REAR nil", - "type": "smuterminalsterminals", - "range": "" - } - ], - "usage": [ - "terminals = smu.terminals", - "smu.terminals = terminals" - ], - "overloads": [], - "examples": [ - { - "example": "smu.terminals = smu.TERMINALS_FRONT;", - "description": "Use the front-panel terminals for measurements.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.state()", - "webhelpfile": "25741.htm", - "signature": "trigger.model.state()", - "command_return": "status, status, n", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the present state of the trigger model.", - "details": "This command returns the state of the trigger model. The instrument checks the state of a started trigger model every 100\u00a0ms.This command returns the trigger state and the block that the trigger model last executed.The trigger model states are:", - "param_info": [ - { - "name": "status", - "description": "The status of the trigger model", - "enum": "trigger.STATE_ABORTED nil|trigger.STATE_ABORTING nil|trigger.STATE_BUILDING nil|trigger.STATE_EMPTY nil|trigger.STATE_FAILED nil|trigger.STATE_IDLE nil|trigger.STATE_RUNNING nil|trigger.STATE_WAITING nil", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "status", - "description": "The status of the parallel/dual trigger model", - "enum": "", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "n", - "description": "The last trigger model block that was executed", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status, status, n = trigger.model.state()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.state());", - "description": "An example output if the trigger model is waiting and is at block 9 would be:\n--- --trigger.STATE_WAITING trigger.STATE_EMPTY 9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "27637.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all events from the event log, including entries in the front-panel event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "eventlog.next()", - "eventlog.save()" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "27658.htm", - "signature": "eventlog.next(eventType)", - "command_return": "eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log.", - "details": "When an event occurs on the instrument, it is placed in the event log. The eventlog.next() command retrieves an unread event from the event log. Once an event is read, it can no longer be accessed remotely. However, it can be viewed on the front panel. When localnode.showevents is enabled, this command never returns an event because those events are automatically read and sent to the remote interface.To read multiple events, execute this command multiple times.If there are no entries in the event log, the following is returned:If the event type is not defined, an event of any type is returned.", - "param_info": [ - { - "name": "eventNumber", - "description": "The event number", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "message", - "description": "A description of the event", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity of the event", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "nodeID", - "description": "The TSP-Link node where the event occurred or 0 if the event occurred on the local node", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeSeconds", - "description": "The seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeNanoSeconds", - "description": "The fractional seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlognexteventType", - "range": "" - } - ], - "usage": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()", - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next(eventType)" - ], - "overloads": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()" - ], - "examples": [ - { - "example": "print(eventlog.next(5));", - "description": "Get the oldest error or information event from the event log.\n--- --Example output:\n--- ---285 TSP Syntax error at line 1: unexpected symbol near `0' 1 0 1367806152 652040060\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.getcount()", - "eventlog.save()" - ] - }, - { - "name": "file.read()", - "webhelpfile": "27929.htm", - "signature": "file.read(fileNumber, readAction)", - "command_return": "fileContents", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file on the USB flash drive.", - "details": "This command reads data from a file.", - "param_info": [ - { - "name": "fileContents", - "description": "The contents of the file based on the readAction parameter", - "enum": "", - "type": "string | nil", - "range": "" - }, - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to read", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "readAction", - "description": "The action", - "enum": "file.READ_LINE nil|file.READ_NUMBER nil|file.READ_ALL nil", - "type": "filereadreadAction", - "range": "" - } - ], - "usage": [ - "fileContents = file.read(fileNumber, readAction)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_READ);if file_num != nil then; file_contents = file.read(file_num, file.READ_ALL); file.close(file_num);end;", - "description": "Open testfile.txt on the USB flash drive for reading. If it opens successfully, read the entire contents of the file and store it in variable file_contents.\n--- --Close the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.close()", - "webhelpfile": "27930.htm", - "signature": "file.close(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes a file on the USB flash drive.", - "details": "Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to close", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.close(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/GENTRIGGER\", file.MODE_WRITE);file.close(file_num);", - "description": "Open the file GENTRIGGER for writing, then close it.\n" - } - ], - "related_commands": [ - "file.open()" - ] - }, - { - "name": "file.write()", - "webhelpfile": "27934.htm", - "signature": "file.write(fileNumber, string)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file on the USB flash drive.", - "details": "The file.write() function may include data that is buffering; it may not be written to the USB flash drive immediately. Use the file.flush() function to immediately write buffered data to the drive.You must use the file.close() command to close the file after writing.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to write", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "string", - "description": "A string that contains the data to write to the file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.write(fileNumber, string)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "file.close()", - "file.flush() " - ] - }, - { - "name": "file.flush()", - "webhelpfile": "27958.htm", - "signature": "file.flush(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffering data to a file on the USB flash drive.", - "details": "The file.write() function may be buffering data instead of writing immediately to the USB flash drive. Use file.flush() to flush this data. Data may be lost if the file is not closed or flushed before a script ends.If there is going to be a time delay before more data is written to a file, flush the file to prevent loss of data because of an aborted test.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to flush", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.flush(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();\u00a0;-- Fix the range to 10 V;smu.measure.range = 10;\u00a0;-- Set the measurement count to 100;smu.measure.count = 100;\u00a0;-- Set up reading buffers;-- Ensure the default measurement buffer size matches the count;defbuffer1.capacity = 100;smu.measure.read();\u00a0;testDir = \"TestData5\";\u00a0;-- create a directory on the USB drive for the data;file.mkdir(testDir);fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";buffer.save(defbuffer1, fileName);\u00a0;if file.usbdriveexists() != 0 then; -- testDir = \"TestData3\";\u00a0; -- Create a directory on the USB drive for the data; -- file.mkdir(testDir); -- Open the file where the data will be stored; -- fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\"; fileNumber = file.open(fileName, file.MODE_APPEND);-- Write header separator to file; file.write(fileNumber, \"\\n\\n====================================================================\\n\");-- Write the string data to a file; file.write(fileNumber, \"Tested to Company Standard ABC.123\\n\");-- Ensure a hurry-up of data written to the file before close or script end; file.flush(fileNumber);-- Close the data file; file.close(fileNumber);\u00a0;end;", - "description": "This example writes a string that indicates that the readings were made for a certain reason, such as to test to a company standard.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.output", - "webhelpfile": "28022.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "When the output is switched on, the instrument sources either voltage or current, as set by smu.source.func.", - "param_info": [ - { - "name": "sourceOutput", - "description": "Switch the source output off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceoutputsourceOutput", - "range": "" - } - ], - "usage": [ - "sourceOutput = smu.source.output", - "smu.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.output = smu.ON;", - "description": "Switch the source output of the instrument to on.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.offmode" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "28048.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "format.LITTLEENDIAN\n", - "tsp_link": "No\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.REAL32 and format.REAL64 data formats.If you are sending data to a computer with a Microsoft Windows operating system, select the format.LITTLEENDIAN byte order.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.BIGENDIAN nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "Output depends on the terminal program you use, but will look something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "28056.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "0 (Automatic)\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number from 1 to 16; set to 0 to have the instrument select the precision automatically based on the number that is being formatted", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.54000000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "28063.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "format.ASCII\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "You can control the precision of numeric values with the format.asciiprecision attribute. If format.REAL32 or format.REAL64 is selected, you can select the byte order with the format.byteorder attribute.The IEEE Std 754 binary formats use four bytes for single-precision values and eight bytes for double-precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCII nil|format.REAL32 nil|format.REAL64 nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "trigger.lanin[N].edge", - "webhelpfile": "28111.htm", - "signature": "", - "command_return": "edgeMode", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_EITHER\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.", - "param_info": [ - { - "name": "edgeMode", - "description": "The trigger mode; see the Details for more information", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "edgeMode = trigger.lanin[N].edge", - "trigger.lanin[N].edge = edgeMode" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[1].edge = trigger.EDGE_FALLING;", - "description": "Set the edge state of LAN event 1 to falling.\n" - } - ], - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "smu.measure.displaydigits", - "webhelpfile": "28416.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "smu.DIGITS_5_5\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the number of digits that are displayed for measurements on the front panel for the selected function.", - "details": "This command affects how the reading for a measurement is displayed on the front panel of the instrument. It does not affect the number of digits returned in a remote command reading. It also does not affect the accuracy or speed of measurements.The display digits setting is saved with the function setting, so if you use another function, then return to the function for which you set display digits, the display digits setting you set previously is retained.The change in digits occurs the next time a measurement is made.To change the number of digits returned in a remote command reading, use format.asciiprecision.", - "param_info": [ - { - "name": "digits", - "description": "6\u00bd display digits", - "enum": "smu.DIGITS_6_5 nil|smu.DIGITS_5_5 nil|smu.DIGITS_4_5 nil|smu.DIGITS_3_5 nil", - "type": "smumeasuredisplaydigitsdigits", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuredisplaydigitsfunction", - "range": "" - } - ], - "usage": [ - "digits = smu.measure.displaydigits", - "smu.measure.displaydigits = digits", - "digits = smu.measure.getattribute(function, ATTR_MEAS_DIGITS)", - "smu.measure.setattribute(function, ATTR_MEAS_DIGITS, digits)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.displaydigits = smu.DIGITS_6_5;", - "description": "Set the measurement function to voltage with a front-panel display resolution of 6\u00bd.\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "smu.measure.configlist.catalog()", - "webhelpfile": "28417.htm", - "signature": "smu.measure.configlist.catalog()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one measure configuration list that is stored on the instrument.", - "details": "You can use this command to retrieve the names of measure configuration lists that are stored in the instrument. This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no measure configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "output", - "description": "Returns the name of one measure configuration list that is stored on the instrument", - "enum": "", - "type": "string | nil", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.catalog());", - "description": "Request the name of one measure configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.query()", - "webhelpfile": "28418.htm", - "signature": "smu.measure.configlist.query(listName, index, fieldSeparator)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command recalls data for one configuration index.For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "output", - "description": "Returns a list of TSP commands and parameter settings that are stored in the specified configuration index", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.query(listName, index)", - "output = smu.measure.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "output = smu.measure.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "reset();smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.range = 35e-3;smu.measure.configlist.create(\"MyDigiCurrList\");smu.measure.configlist.store(\"MyDigiCurrList\");print(smu.measure.configlist.query(\"MyDigiCurrList\", 1, '\\n'));", - "description": "Set the digitize function to current and the range to 35 mA. Create a configuration list named MyDigiCurrList and store the active digitize settings in index 1 of that list. Then query for all of the digitize settings for index 1 in that list.\n--- --\u00a0\n--- --Output:\n--- --smu.measure.func = is not used\n--- --smu.measure.range = is not used\n--- --smu.measure.autorange = = smu.OFF\n--- --smu.measure.autorangelow = is not used\n--- --smu.measure.autozero.enable = = smu.OFF\n--- --smu.measure.displaydigits = is not used\n--- --smu.measure.filter.enable = = smu.OFF\n--- --smu.measure.filter.count = is not used\n--- --smu.measure.filter.type = is not used\n--- --smu.measure.limit[1].autoclear = = smu.OFF\n--- --smu.measure.limit[1].enable = = smu.OFF\n--- --smu.measure.limit[1].audible = is not used\n--- --smu.measure.limit[1].high.value = is not used\n--- --smu.measure.limit[1].low.value = is not used\n--- --smu.measure.limit[2].autoclear = = smu.OFF\n--- --smu.measure.limit[2].audible = is not used\n--- --smu.measure.limit[2].enable = = smu.OFF\n--- --smu.measure.limit[2].high.value = is not used\n--- --smu.measure.limit[2].low.value = is not used\n--- --smu.measure.math.enable = = smu.OFF\n--- --smu.measure.math.format = is not used\n--- --smu.measure.math.mxb.bfactor = is not used\n--- --smu.measure.math.mxb.mfactor = is not used\n--- --smu.measure.math.percent = is not used\n--- --smu.measure.userdelay[1] = is not used\n--- --smu.measure.userdelay[2] = is not used\n--- --smu.measure.userdelay[3] = is not used\n--- --smu.measure.userdelay[4] = is not used\n--- --smu.measure.userdelay[5] = is not used\n--- --smu.measure.nplc = is not used\n--- --smu.measure.offsetcompensation = = smu.OFF\n--- --smu.measure.autorangehigh = is not used\n--- --smu.measure.sense = is not used\n--- --smu.measure.unit = is not used\n--- --smu.measure.rel.enable = = smu.OFF\n--- --smu.measure.rel.level = is not used\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.recall()", - "webhelpfile": "28419.htm", - "signature": "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a configuration index in a measure configuration list and an optional source configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a measure configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified measure configuration list. You can optionally specify a source configuration list and index to recall with the measure settings. If you do not specify a source index, the source index defaults to match the measure index. Specify a measure and source list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need the source and measure configuration lists coordinated, you can specify just the measure configuration list with this command and use the smu.source.configlist.recall() command to recall source settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, an error message is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. A single index stores the settings associated with a single measure or digitize function.This command recalls data for one configuration index from the specified measure configuration list and from the source configuration list (if specified).For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sourceListName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceIndex", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)", - "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)" - ], - "overloads": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.recall(\"MyMeasList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.measure.configlist.delete()", - "webhelpfile": "28421.htm", - "signature": "smu.measure.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a measure configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.delete(listName)", - "smu.measure.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.delete(\"myMeasList\");", - "description": "Delete a measure configuration list named myMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "lan.macaddress", - "webhelpfile": "28423.htm", - "signature": "", - "command_return": "MACaddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute describes the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets.", - "param_info": [ - { - "name": "MACaddress", - "description": "The MAC address of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "MACaddress = lan.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.macaddress);", - "description": "Returns the MAC address. For example:\n--- --08:00:11:00:00:57\n" - } - ], - "related_commands": [ - "lan.ipconfig()" - ] - }, - { - "name": "smu.measure.autozero.enable", - "webhelpfile": "29048.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "To ensure the accuracy of readings, the instrument must periodically get new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture that is being used for measurements. The Model 2461 uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made.The time to make the reference measurements is in addition to the normal measurement time. If timing is critical, such as in sweeps, you can disable autozero to avoid this time penalty.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "state", - "description": "The status of autozero; set to one of the following values", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautozeroenablestate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautozeroenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autozero.enable", - "smu.measure.autozero.enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_AUTO_ZERO)", - "smu.measure.setattribute(function, ATTR_MEAS_AUTO_ZERO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autozero.enable = smu.OFF;", - "description": "Set autozero off for voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.once()", - "smu.measure.nplc" - ] - }, - { - "name": "smu.measure.autozero.once()", - "webhelpfile": "29049.htm", - "signature": "smu.measure.autozero.once()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to refresh the reference and zero measurements once.", - "details": "This command forces a refresh of the reference and zero measurements that are used for the present aperture setting for the selected function.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "smu.measure.autozero.once()", - "description": "Do a one-time refresh of the reference and zero measurements.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.autozero.once()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.autozero.once();", - "description": "Do a one-time refresh of the reference and zero measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.enable" - ] - }, - { - "name": "smu.measure.nplc", - "webhelpfile": "29064.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the time that the input signal is measured for the selected function.", - "details": "This command sets the amount of time that the input signal is measured.The amount of time is specified as the number of power line cycles (NPLCs). Each PLC for 60\u00a0Hz is 16.67\u00a0ms (1/60) and each PLC for 50\u00a0Hz is 20\u00a0ms (1/50). For 60\u00a0Hz, if you set the NPLC to 0.1, the measure time is 1.667 ms.This command is set for the measurement of specific functions (current, resistance, or voltage).The shortest amount of time results in the fastest reading rate but increases the reading noise and decreases the number of usable digits.The longest amount of time provides the lowest reading noise and more usable digits but has the slowest reading rate.Settings between the fastest and slowest number of power line cycles are a compromise between speed and noise.If you change the PLCs, you may want to adjust the displayed digits to reflect the change in usable digits.", - "param_info": [ - { - "name": "nplc", - "description": "The number of power line cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurenplcfunction", - "range": "" - } - ], - "usage": [ - "nplc = smu.measure.nplc", - "smu.measure.nplc = nplc", - "nplc = smu.measure.getattribute(function, ATTR_MEAS_NPLC)", - "smu.measure.setattribute(function, ATTR_MEAS_NPLC, nplc)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.nplc = 0.5;", - "description": "Set the measurement function to DC Voltage.\n--- --Set the NPLC value to 0.5, which is 0.0083\u00a0seconds (0.5/60).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.protect.level", - "webhelpfile": "29072.htm", - "signature": "", - "command_return": "PROTECT_x", - "type": "Attribute (RW)", - "default_value": "smu.PROTECT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the overvoltage protection setting of the source output.", - "details": "Overvoltage protection restricts the maximum voltage level that the instrument can source. It is in effect when either current or voltage is sourced.This protection is in effect for both positive and negative output voltages.When this attribute is used in a test sequence, it should be set before turning the source on.", - "param_info": [ - { - "name": "PROTECT_x", - "description": "The overvoltage protection level, 2V, 5V, 10V, 20V, 40V, 60V, 80V, or NONEsmu.PROTECT_2Vsmu.PROTECT_5Vsmu.PROTECT_10Vsmu.PROTECT_20Vsmu.PROTECT_40Vsmu.PROTECT_60Vsmu.PROTECT_80Vsmu.PROTECT_NONE", - "enum": "smu.PROTECT_2V nil|smu.PROTECT_5V nil|smu.PROTECT_10V nil|smu.PROTECT_20V nil|smu.PROTECT_40V nil|smu.PROTECT_60V nil|smu.PROTECT_80V nil|smu.PROTECT_NONE nil", - "type": "smusourceprotectlevelPROTECT_x", - "range": "" - }, - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceprotectlevelsourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotectlevelfunction", - "range": "" - } - ], - "usage": [ - "PROTECT_x = smu.source.protect.level", - "smu.source.protect.level = PROTECT_x", - "PROTECT_x = smu.source.getattribute(function, ATTR_SRC_PROTECT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_PROTECT_LEVEL, PROTECT_x)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.protect.level = smu.PROTECT_40V;", - "description": "Sets the maximum voltage limit of the instrument to 40\u00a0V.\n" - } - ], - "related_commands": [ - "Overvoltage protection" - ] - }, - { - "name": "smu.source.delay", - "webhelpfile": "29079.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This command sets a delay for the selected source function. This delay is in addition to normal settling times.After the programmed source is turned on, this delay allows the source level to settle before a measurement is made.If you set a specific source delay (smu.source.delay), source autodelay is turned off.When source autodelay is turned on, the manual source delay setting is overwritten with the autodelay setting.When either a source delay or autodelay is set, the delay is applied to the first source output and then only when the magnitude of the source changes.", - "param_info": [ - { - "name": "sDelay", - "description": "The length of the delay (0 to 10 ks)", - "enum": "", - "type": "number", - "range": "(0 to 10 ks)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcedelayfunction", - "range": "" - } - ], - "usage": [ - "sDelay = smu.source.delay", - "smu.source.delay = sDelay", - "sDelay = smu.source.getattribute(function, ATTR_SRC_DELAY)", - "smu.source.setattribute(function, ATTR_SRC_DELAY, sDelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.delay = 3;", - "description": "Set the function to voltage. Set a 3 s delay after the source is turned on before a measurement is made.\n" - } - ], - "related_commands": [ - "smu.source.autodelay" - ] - }, - { - "name": "smu.measure.offsetcompensation", - "webhelpfile": "29137.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if offset compensation is used.", - "details": "This feature is only available for resistance measurements or when the smu.measure.unit is set to smu.UNIT_OHM.", - "param_info": [ - { - "name": "state", - "description": "Disable offset compensation", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureoffsetcompensationstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureoffsetcompensationfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.offsetcompensation", - "smu.measure.offsetcompensation = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_OFFSET_COMP)", - "smu.measure.setattribute(function, ATTR_MEAS_OFFSET_COMP, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;smu.measure.offsetcompensation = smu.ON;smu.source.output = smu.ON;print(smu.measure.read());smu.source.output = smu.OFF;", - "description": "Sets the measurement function to resistance. Set the instrument for 4-wire measurements and turn offset compensation on. Turn on the source, make a measurement, and turn the source off.\n--- --Example output:\n--- --81592000\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.offmode", - "webhelpfile": "29238.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "smu.OFFMODE_NORMAL\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the state of the source when the output is turned off.", - "details": "", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceoffmodesourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceoffmodefunction", - "range": "" - } - ], - "usage": [ - "sourceOffMode = smu.source.offmode", - "smu.source.offmode = sourceOffMode", - "sourceOffMode = smu.source.getattribute(function, ATTR_SRC_OFFMODE)", - "smu.source.setattribute(function, ATTR_SRC_OFFMODE, sourceOffMode)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.offmode = smu.OFFMODE_HIGHZ;", - "description": "Sets the output-off state so that the instrument opens the output relay when the output is turned off.\n" - } - ], - "related_commands": [ - "smu.source.output" - ] - }, - { - "name": "smu.source.func", - "webhelpfile": "29382.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_VOLTAGE\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "When you set this command, it configures the instrument as either a voltage source or a current source.When you read this command, it returns the output setting of the source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcefuncsFunction", - "range": "" - } - ], - "usage": [ - "sFunction = smu.source.func", - "smu.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;", - "description": "Sets the source function of the instrument to be a current source.\n" - } - ], - "related_commands": [ - "smu.source.level", - "smu.source.output" - ] - }, - { - "name": "smu.source.range", - "webhelpfile": "29383.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 1 \u00b5AVoltage: 200 mV\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the range for the source for the selected source function.", - "details": "This command manually selects the measurement range for the specified source.To select the range, specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 3\u00a0V, set the source level to 3. The Model 2461 selects the 20\u00a0V range.If you select a specific source range, the range must be large enough to source the value. If not, an overrange condition can occur.If an overrange condition occurs, an event is displayed and the change to the setting is ignored.The fixed current source ranges are 1\u00a0\u00b5A, 10\u00a0\u00b5A, 100\u00a0\u00b5A, 1\u00a0mA, 10\u00a0mA, 100\u00a0mA, 1\u00a0A, 4\u00a0A, 5\u00a0A, 7\u00a0A, and 10\u00a0A. Note that if the 10\u00a0A range is selected, the maximum source output level is 7.35\u00a0A unless pulsing is active.The fixed voltage source ranges are 200\u00a0mV, 2\u00a0V, 7\u00a0V, 10\u00a0V, 20\u00a0V, and 100\u00a0V.When you read this value, the instrument returns the positive full-scale value that the instrument is presently using.This command is intended to eliminate the time required by the automatic range selection.To select the range, you can specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 50\u00a0mV, send 0.05 (or 50e-3) to select the 200\u00a0mV range.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced; see Details for values; the ranges are", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.source.range", - "smu.source.range = rangeValue", - "rangeValue = smu.source.getattribute(function, ATTR_SRC_RANGE)", - "smu.source.setattribute(function, ATTR_SRC_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.OFF;smu.source.range = 1;", - "description": "Set the instrument to source current.\n--- --Turn autorange off.\n--- --Set the source range to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.autorange" - ] - }, - { - "name": "smu.source.autorange", - "webhelpfile": "29386.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the range is selected manually or automatically for the selected source function or voltage source.", - "details": "This command indicates the state of the range for the selected source. When automatic source range is disabled, the source range is set manually.When automatic source range is enabled, the instrument selects the range that is most appropriate for the value that is being sourced. The output level controls the range. If you read the range after the output level is set, the instrument returns the range that the instrument chose as appropriate for that source level.If the source range is set to a specific value from the front panel or a remote command, the setting for automatic range is set to disabled.Only available for the current and voltage functions.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautorangesourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautorangefunction", - "range": "" - } - ], - "usage": [ - "sourceAutorange = smu.source.autorange", - "smu.source.autorange = sourceAutorange", - "sourceAutorange = smu.source.getattribute(function, ATTR_SRC_RANGE_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_RANGE_AUTO, sourceAutorange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.ON;", - "description": "Set the source function to current.\n--- --Set the instrument to select the source range automatically.\n" - } - ], - "related_commands": [ - "smu.source.range" - ] - }, - { - "name": "smu.measure.autorange", - "webhelpfile": "29393.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the measurement range is set manually or automatically for the selected measure function.", - "details": "Autorange selects the best range in which to measure the signal that is applied to the input terminals of the instrument. When autorange is enabled, the range increases at 120 percent of range. The range decreases occur when the reading is <10\u00a0percent of nominal range.This command determines how the range is selected.When this command is set to off, you must set the range. If you do not set the range, the instrument remains at the range that was last selected by autorange.When this command is set to on, the instrument automatically goes to the most sensitive range to perform the measurement.", - "param_info": [ - { - "name": "autoRange", - "description": "Set the measurement range manually", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangeautoRange", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangefunction", - "range": "" - } - ], - "usage": [ - "autoRange = smu.measure.autorange", - "smu.measure.autorange = autoRange", - "autoRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_AUTO)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_AUTO, autoRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n" - } - ], - "related_commands": [ - "smu.measure.range" - ] - }, - { - "name": "smu.measure.range", - "webhelpfile": "29407.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 1 \u00b5AResistance: 200 M\u03a9Voltage: 2 V\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale measure range.", - "details": "You can assign any real number using this command. The instrument selects the closest fixed range that is large enough to measure the entered number. For example, for current measurements, if you expect a reading of approximately 9\u00a0mA, set the range to 9 mA to select the 10\u00a0mA range. When you read this setting, you see the positive full-scale value of the measurement range that the instrument is presently using.This command is primarily intended to eliminate the time that is required by the instrument to automatically search for a range.When a range is fixed, any signal greater than the entered range generates an overrange condition. When an overrange condition occurs, the front panel displays \"Overflow\" and the remote interface returns 9.9e+37.If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is the same as the source range, regardless of measurement range setting. However, the setting for the measure range is retained, and when the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.If you change the range while the output is off, the instrument does not update the hardware settings, but if you read the range setting, the return is the setting that will be used when the output is turned on. If you set a range while the output is on, the new setting takes effect immediately.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected value to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.measure.range", - "smu.measure.range = rangeValue", - "rangeValue = smu.measure.getattribute(function, ATTR_MEAS_RANGE)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 0.5;", - "description": "Set the source function to current.\n--- --Set the measurement function to voltage.\n--- --Instrument selects the 2 V measurement range.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangelow", - "webhelpfile": "29423.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 1 \u00b5AVoltage: 200 mVResistance: 2 \u03a9\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the lower limit for measurements of the selected function when the range is selected automatically.", - "details": "You can use this command when automatic range selection is enabled. It prevents the instrument from selecting a range that is below this limit. Because the lowest ranges generally require longer settling times, setting the low limit that is appropriate for your application but above the lowest possible range can make measurements require less settling time.The lower limit must be less than the upper limit.Though you can send any value when you send this command, the instrument selects the next highest range value. For example, if you send 15 for the lowest voltage range, the instrument will be set to the 20\u00a0V range as the low limit. If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "lowRange", - "description": "The lower limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangelowfunction", - "range": "" - } - ], - "usage": [ - "lowRange = smu.measure.autorangerangelow", - "smu.measure.autorangerangelow = lowRange", - "lowRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_LOW)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_LOW, lowRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;smu.measure.autorangelow = 2;", - "description": "Sets the low range for voltage measurements to 2\u00a0V.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangehigh", - "webhelpfile": "29432.htm", - "signature": "", - "command_return": "highRange", - "type": "AttributeResistance: (RW)Voltage and current: (R)", - "default_value": "Resistance: 200\u00a0M\u03a9\n", - "tsp_link": "Yes\n", - "description": "When autorange is selected, this attribute represents the highest measurement range that is used when the instrument selects the measurement range automatically.", - "details": "This command can be written to and read for resistance measurements. For current and voltage measurements, it can only be read.For current and voltage measurements, the upper limit is controlled by the current or voltage limit.For resistance measurements, you can use this command when automatic range selection is enabled to put an upper bound on the range that is used for resistance measurements.The upper limit must be more than the lower limit.If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "highRange", - "description": "The highest measurement range that is used when the range is set automatically", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangehighfunction", - "range": "" - } - ], - "usage": [ - "highRange = smu.measure.autorangehigh", - "smu.measure.autorangehigh = highRange", - "highRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_HIGH)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_HIGH, highRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;print(smu.measure.autorangehigh);", - "description": "Sets the measurement function to voltage and turn autorange on. Check the high range for voltage measurements.\n" - } - ], - "related_commands": [ - "reset()", - "smu.measure.autorange", - "smu.reset()" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "29636.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the instrument to provide an audible signal at a specific frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.Using this function from a remote interface does not affect audible errors or key click settings that were made from the Model 2461 front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the beep (20\u00a0Hz to 8000 Hz)", - "enum": "", - "type": "number", - "range": "(20\u00a0Hz to 8000 Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(2, 2400);", - "description": "Generates a 2 s, 2400\u00a0Hz tone.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "29846.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete (OPC) bit after all pending commands, including overlapped commands, have been executed.", - "details": "This function causes the operation complete bit in the Status Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "smu.measure.limit[Y].enable", - "webhelpfile": "29884.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables a limit test on the measurement from the selected measure function.", - "details": "This command enables or disables a limit test for the selected measurement function. When this attribute is enabled, the limit Y testing occurs on each measurement made by the instrument. Limit Y testing compares the measurements to the high-limit and low-limit values. If a measurement falls outside these limits, the test fails.", - "param_info": [ - { - "name": "state", - "description": "Disable the test", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitenablestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].enable", - "smu.measure.limit[Y].enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.limit[1].enable = smu.ON;", - "description": "Enable testing for limit 1 when measuring voltage.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].clear()", - "smu.measure.limit[Y].fail", - "smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].low.value" - ] - }, - { - "name": "smu.source.level", - "webhelpfile": "29907.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute immediately selects a fixed amplitude for the selected source function.", - "details": "This command sets the output level of the voltage or current source. If the output is on, the new level is sourced immediately.The sign of the source level dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.If a manual source range is selected, the level cannot exceed the specified range. For example, if the voltage source is on the 2\u00a0V range, you cannot set the voltage source level to 3\u00a0V. When autorange is selected, the amplitude can be set to any level supported by the instrument.", - "param_info": [ - { - "name": "sourceLevel", - "description": "Current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcelevelfunction", - "range": "" - } - ], - "usage": [ - "sourceLevel = smu.source.level", - "smu.source.level = sourceLevel", - "sourceLevel = smu.source.getattribute(function, ATTR_SRC_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LEVEL, sourceLevel)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 1;", - "description": "Set the instrument to source voltage and set it to source 1\u00a0V.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.output", - "smu.source.protect.level" - ] - }, - { - "name": "smu.measure.rel.enable", - "webhelpfile": "29986.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the application of a relative offset value to the measurement.", - "details": "When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value calculated when you acquire the relative offset value.Each returned measured relative reading is the result of the following calculation:", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurerelenablerelEnable", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerelenablefunction", - "range": "" - } - ], - "usage": [ - "relEnable = smu.measure.rel.enable", - "smu.measure.rel.enable = relEnable", - "relEnable = smu.measure.getattribute(function, ATTR_MEAS_REL_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_ENABLE, relEnable)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.rel.level", - "webhelpfile": "29987.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the relative offset value.", - "details": "This command specifies the relative offset value that can be applied to new measurements. When relative offset is enabled, all subsequent measured readings are offset by the value that is set for this\u00a0command.You can set this value, or have the instrument acquire a value. If the instrument acquires the value, read this setting to return the value that was measured\u00a0internally.", - "param_info": [ - { - "name": "relValue", - "description": "Relative offset value for measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerellevelfunction", - "range": "" - } - ], - "usage": [ - "relValue = smu.measure.rel.level", - "smu.measure.rel.level = relValue", - "relValue = smu.measure.getattribute(function, ATTR_MEAS_REL_LEVEL)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_LEVEL, relValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.rel.level = smu.measure.read();smu.measure.rel.enable = smu.ON;", - "description": "Sets the measurement function to current, performs a current measurement, uses it as the relative offset value, and enables the relative offset for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.enable" - ] - }, - { - "name": "smu.measure.filter.count", - "webhelpfile": "30064.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements that are averaged when filtering is enabled.", - "details": "The filter count is the number of readings that are acquired and stored in the filter stack for the averaging calculation. When the filter count is larger, more filtering is done, and the data is less noisy.This command is set for the selected function.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltercountfunction", - "range": "" - } - ], - "usage": [ - "filterCount = smu.measure.filter.count", - "smu.measure.filter.count = filterCount", - "filterCount = smu.measure.getattribute(function, ATTR_MEAS_FILTER_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_COUNT, filterCount)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.enable", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.filter.type", - "webhelpfile": "30065.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "smu.FILTER_REPEAT_AVG\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the type of averaging filter that is used for the selected measure function when the measurement filter is enabled.", - "details": "You can select one of two types of averaging filters: repeating average or moving average.When the repeating average filter is selected, a set of measurements are made. These measurements are stored in a measurement stack and averaged together to produce the averaged sample. Once the averaged sample is produced, the stack is flushed, and the next set of data is used to produce the next averaged sample. This type of filter is the slowest, since the stack must be completely filled before an averaged sample can be produced.When the moving average filter is selected, the measurements are added to the stack continuously on a first-in, first-out basis. As each measurement is made, the oldest measurement is removed from the stack. A new averaged sample is produced using the new measurement and the data that is now in the stack.The repeating average filter produces slower results but produces more stable results than the moving average filter. For either method, the greater the number of measurements that are averaged, the slower the averaged sample rate, but the lower the noise error. Trade-offs between speed and noise are normally required to tailor the instrumentation to your measurement application.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled; set to one of the following values", - "enum": "smu.FILTER_MOVING_AVG nil|smu.FILTER_REPEAT_AVG nil", - "type": "smumeasurefiltertypefilterType", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltertypefunction", - "range": "" - } - ], - "usage": [ - "filterType = smu.measure.filter.type", - "smu.measure.filter.type = filterType", - "filterType = smu.measure.getattribute(function, ATTR_MEAS_FILTER_TYPE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_TYPE, filterType)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.enable" - ] - }, - { - "name": "smu.measure.filter.enable", - "webhelpfile": "30066.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the averaging filter for the selected measurement function.", - "details": "This command enables or disables the averaging filter. When this is enabled, the reading returned by the instrument is an averaged value, taken from multiple measurements. The settings of the filter count and filter type for the selected measure function determines how the reading is averaged.Filters are not available for digitize functions.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurefilterenablefilterState", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefilterenablefunction", - "range": "" - } - ], - "usage": [ - "filterState = smu.measure.filter.enable", - "smu.measure.filter.enable = filterState", - "filterState = smu.measure.getattribute(function, ATTR_MEAS_FILTER_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_ENABLE, filterState)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.math.mxb.bfactor", - "webhelpfile": "30107.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the offset, b, for the y = mx + b operation.", - "details": "This attribute specifies the offset (b) for an mx + b operation.The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation:Where:", - "param_info": [ - { - "name": "value", - "description": "The offset for the y = mx + b operation; the valid range is -1e12 to +>1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbbfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.bfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_BF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_BF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx +b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.mfactor" - ] - }, - { - "name": "smu.measure.math.mxb.mfactor", - "webhelpfile": "30108.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the scale factor, m, for the y = mx + b math operation.", - "details": "This command sets the scale factor (m) for an mx + b operation for the selected measurement function.The mx + b math operation lets you manipulate normal display readings (x) mathematically according to the following calculation:Where: ", - "param_info": [ - { - "name": "value", - "description": "The scale factor; the valid range is -1e12 to +>1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbmfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.mfactor", - "smu.measure.math.mxb.mfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_MF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_MF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx+b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor" - ] - }, - { - "name": "smu.measure.math.percent", - "webhelpfile": "30109.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the reference constant that is used when math operations are set to percent.", - "details": "This is the constant that is used when the math operation is set to percent for the selected measurement function.The percent math function displays measurements as percent deviation from a specified reference constant. The percent calculation is:Where:", - "param_info": [ - { - "name": "value", - "description": "The reference used when the math operation is set to percent; the range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathpercentfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.percent", - "smu.measure.math.percent = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_PERCENT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_PERCENT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.percent = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operations to percent.\n--- --Set the percentage value to 50 for voltage measurements.\n--- --Enable math operations.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.format" - ] - }, - { - "name": "smu.source.protect.tripped", - "webhelpfile": "30235.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the overvoltage source protection feature is active.", - "details": "When overvoltage protection is active, the instrument restricts the maximum voltage level that the instrument can source.", - "param_info": [ - { - "name": "value", - "description": "Overvoltage protection not active", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceprotecttrippedvalue", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotecttrippedfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.protect.tripped", - "value = smu.source.getattribute(function, ATTR_SRC_PROTECT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.protect.tripped);", - "description": "If overvoltage protection is active, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "Overvoltage protection", - "smu.source.protect.level" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "30485.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all readings and statistics from the specified buffer.", - "details": "", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);testData.clear();print(\"Readings in buffer after clear =\" .. testData.n);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);", - "description": "Create a reading buffer named testData, make three readings and store them in testData, and then view the readings.\n--- --Print number of readings in testData.\n--- --Output:\n--- ---4.5010112303956e-10, -3.9923108222095e-12, -4.5013931471161e-10\n--- --Clear the readings in testData.\n--- --Verify that there are no readings in testData.\n--- --Output:\n--- --Readings in buffer after clear = 0\n--- --Store three new readings in testData and view those when complete.\n--- --Output:\n--- --4.923509754e-07, 3.332266330e-07, 3.974883867e-07\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.dates", - "webhelpfile": "30488.htm", - "signature": "bufferVar.dates[N]", - "command_return": "date", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the dates of readings that are stored in the reading buffer.", - "details": "The dates are formatted as month, day, year.This is not available if the reading buffer style is set to compact.", - "param_info": [ - { - "name": "date", - "description": "The date of readings stored in bufferVar element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "date = bufferVar.dates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 1, testData);trigger.model.initiate();waitcomplete();print(testData.dates[1]);printbuffer(1, testData.n, testData.dates);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Example output:\n--- --11/27/2017\n--- --Prints the dates for readings 1 through the last reading in the buffer.\n--- --Example output:\n--- --11/27/2017, 11/27/2017, 11/27/2017\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "30489.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "User-defined buffer: buffer.FILL_ONCE (0)defbuffer1: buffer.FILL_CONTINUOUS (1)defbuffer2: buffer.FILL_CONTINUOUS (1)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if a reading buffer is filled continuously or is filled once and stops.", - "details": "When a reading buffer is set to fill once, no data is overwritten in the buffer. When the buffer is filled, no more data is stored in that buffer and new readings are discarded.When a reading buffer is set to fill continuously, the oldest data is overwritten by the newest data after the buffer fills.When you change the fill mode of a buffer, any data in the buffer is cleared.", - "param_info": [ - { - "name": "fillMode", - "description": "Fill the buffer, then stop", - "enum": "buffer.FILL_ONCE nil|buffer.FILL_CONTINUOUS nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);print(testData.fillmode);testData.fillmode = buffer.FILL_CONTINUOUS;print(testData.fillmode);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer. Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --0\n--- --Set fill mode to continuous. \n--- --Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.digout[N].stimulus", - "webhelpfile": "30501.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line.", - "details": "The digital trigger pulsewidth command determines how long the trigger is asserted.The trigger stimulus for a digital I/O line can be set to one of the trigger events that are described in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "event = trigger.digout[N].stimulus", - "trigger.digout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].stimulus = trigger.EVENT_TIMER3;", - "description": "Set the stimulus for output digital trigger line 2 to be the expiration of trigger timer 3.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()", - "trigger.digout[N].assert()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "30502.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the text from the front-panel USER swipe screen.", - "details": "", - "param_info": [ - { - "name": "display.clear()display.changescreen(display.SCREEN_USER_SWIPE)display.settext(display.TEXT1, \"Serial number:\")display.settext(display.TEXT2, localnode.serialno)", - "description": "Clear the USER swipe screen.Set the first line to read \"Serial number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"Serial number:\");display.settext(display.TEXT2, localnode.serialno);", - "description": "Clear the USER swipe screen.\n--- --Set the first line to read \"Serial number:\" and the second line to display the serial number of the instrument.\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "display.changescreen()", - "webhelpfile": "30503.htm", - "signature": "display.changescreen(screenName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function changes which front-panel screen is displayed.", - "details": "", - "param_info": [ - { - "name": "screenName", - "description": "The screen to display", - "enum": "display.SCREEN_HOME nil|display.SCREEN_HOME_LARGE_READING nil|display.SCREEN_READING_TABLE nil|display.SCREEN_GRAPH nil|display.SCREEN_HISTOGRAM nil|display.SCREEN_GRAPH_SWIPE nil|display.SCREEN_SETTINGS_SWIPE nil|display.SCREEN_SOURCE_SWIPE nil|display.SCREEN_STATS_SWIPE nil|display.SCREEN_USER_SWIPE nil|display.SCREEN_PROCESSING nil", - "type": "displaychangescreenscreenName", - "range": "" - } - ], - "usage": [ - "display.changescreen(screenName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT1, \"Batch A122\");display.settext(display.TEXT2, \"Test running\");display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clear the USER swipe screen.\n--- --Set the first line of the USER swipe screen to read \"Batch A122\" and the second line to display \"Test running\".\n--- --Display the USER swipe screen.\n--- --\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "localnode.showevents", - "webhelpfile": "30504.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (no events sent)\n", - "tsp_link": "No\n", - "description": "This attribute sets whether or not the instrument automatically outputs generated events to the remote interface.", - "details": "Enable this attribute to have the instrument output generated events to the remote interface.Events are output after a command message is executed but before prompts are issued (if prompts are enabled with localnode.prompts).If this attribute is disabled, use eventlog.next() to retrieve unread events from the event log.Events are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable show events when the GPIB connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "errorMode", - "description": "The errors that are returned", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "localnodeshoweventserrorMode", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showevents", - "localnode.showevents = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showevents = eventlog.SEV_ERROR | eventlog.SEV_INFO;trigger.digin[3].edge = trigger.EDGE_EITHER;", - "description": "Send generated error and warning messages.\n--- --Example output if the edge cannot be sent to either:\n--- --1805, Settings conflict: setting input edge when line 3 set for digital\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "localnode.prompts" - ] - }, - { - "name": "smu.measure.count", - "webhelpfile": "30505.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements to make when a measurement is requested.", - "details": "This command sets the number of measurements that are made when a measurement is requested. This command does not affect the trigger model.When smu.measure.count or if the function for smu.measure.setattribute is the active function, this command sets the count for all measure functions. When you send smu.measure.setattribute for a function that is not active, only the count for the specified function is changed.If you set the count to a value that is larger than the capacity of the reading buffer and the buffer fill mode is set to continuous, the buffer wraps until the number of readings specified have occurred. The earliest readings in the count are overwritten. If the buffer is set to fill once, readings stop when the buffer is filled, even if the count is not complete.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements (1 to 300,000 or buffer capacity)", - "enum": "", - "type": "integer", - "range": "(1 to 300,000 or buffer capacity)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurecountfunction", - "range": "" - } - ], - "usage": [ - "count = smu.measure.count", - "smu.measure.count = count", - "count = smu.measure.getattribute(function, ATTR_MEAS_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_COUNT, count)" - ], - "overloads": [], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1;smu.measure.count = 200; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;smu.measure.read(defbuffer1);\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses smu.measure.count to do a capacitor test. This outputs 200 readings that are similar to the following output:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - }, - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example demonstrates how to use the SimpleLoop trigger-model template instead of smu.measure.count to do a capacitor test. Similar to Example 1, this also outputs 200 readings that are similar to the following:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "smu.measure.read()", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.reset()", - "webhelpfile": "30521.htm", - "signature": "smu.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smu. to their default settings.", - "details": "This function turns off the output and resets the commands that begin with smu. to their default settings. It also deletes source and measure configuration lists.", - "param_info": [ - { - "name": "smu.reset()", - "description": "Turns off the output and resets the SMU commands to their default settings.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.reset();", - "description": "Turns off the output and resets the SMU commands to their default settings.\n" - } - ], - "related_commands": [ - "reset()" - ] - }, - { - "name": "status.operation.getmap()", - "webhelpfile": "30523.htm", - "signature": "status.operation.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Operation Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "setEvent, clearEvent = status.operation.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.getmap(0));", - "description": "Query bit 0 of the Operation Event Register.\n--- --Example output:\n--- --4918 4917\n" - } - ], - "related_commands": [ - "Operation Event Register", - "Programmable status register sets", - "status.operation.setmap()" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "30524.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Event Register.", - "details": "This query reads the contents of the questionable status event register. After sending this command and addressing the instrument to talk, a value is sent to the computer. This value indicates which bits in the appropriate register are set.The Questionable Register can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set the Questionable Register to the sum of their decimal weights. For example, to set bits B12 and B13, set the Questionable Register to 12,288 (which is the sum of 4,096\u00a0+\u00a08,192).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the questionable status register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.event" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 66 = binary 0100 0010;questionableRegister = 66;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B1 and B6 of the status questionable enable register.\n" - }, - { - "example": "-- decimal 2560 = binary 00001010 0000 0000;questionableRegister = 2560;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B9 and B11 of the status questionable enable register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "30525.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or sets the bits in the Status Enable register of the Standard Event Register.", - "details": "When a bit in the Status Enable register is set on and the corresponding bit in the Standard Event Status register is set on, the ESB bit of the Status Byte Register is set to on.To set a bit on, send the constant or value of the bit as the standardRegister parameter.You can set the bit as a constant or a numeric value, as shown in the table below. To set more than one bit of the register, you can send multiple constants with + between them. You can also set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B2, set standardRegister to 5 (which is the sum of 1 + 4). You can also send:status.standard.enable = status.standard.OPC + status.standard.QYEWhen zero (0) is returned, no bits are set. You can also send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The value of the Status Enable register of the Standard Event Register (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "standardRegister = status.standard.enable", - "status.standard.enable = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.QYE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and QYE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 5 = binary 0000 0101;standardRegister = 5;status.standard.enable = standardRegister;", - "description": "Uses a decimal value to set the OPC and QYE bits of the standard event status enable register.\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "trigger.timer[N].start.generate", - "webhelpfile": "30536.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies when timer events are generated.", - "details": "When this is set to on, a trigger event is generated immediately when the timer is triggered.When it is set to off, a trigger event is generated when the timer elapses. This generates the event trigger.EVENT_TIMERN.", - "param_info": [ - { - "name": "state", - "description": "Generate a timer event when the timer delay elapses", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerstartgeneratestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.generate", - "trigger.timer[N].start.generate = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;", - "description": "Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "bufferVar.sourceformattedvalues", - "webhelpfile": "30538.htm", - "signature": "bufferVar.sourceformattedvalues[N]", - "command_return": "values", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels formatted as they appear on the front-panel display when the readings in the reading buffer were acquired.", - "details": "The attribute is an array (a Lua table) of the sourced value that was in effect at the time of the reading. The source levels are formatted the same way the readings are formatted when they appear on the front-panel display.", - "param_info": [ - { - "name": "values", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "values = bufferVar.sourceformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 6, 0);trigger.model.initiate();waitcomplete();print(defbuffer1.sourceformattedvalues[1]);printbuffer(1,6,defbuffer1.sourceformattedvalues);", - "description": "Example output:\n--- ---00.00041 mV\n--- --Example output:\n--- ---00.00041 mV, +00.00010 mV, -00.00033 mV, +00.00003 mV, -00.00028 mV, -00.00045 mV\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fractionalseconds", - "webhelpfile": "30542.htm", - "signature": "bufferVar.fractionalseconds[N]", - "command_return": "fractionalSec", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the fractional second portion of the timestamp of each reading in the reading buffer.", - "details": "This read-only attribute is an array of the fractional portion of the timestamp, in seconds, when each reading occurred. Seconds are shown as fractions.", - "param_info": [ - { - "name": "fractionalSec", - "description": "The fractional second portion of the timestamp to 1\u00a0ns resolution", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "fractionalSec = bufferVar.fractionalseconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();print(testData.fractionalseconds[1]);printbuffer(1, 6, testData.fractionalseconds);", - "description": "Create a reading buffer named testData and make six measurements.\n--- --Print the fractional portion of the timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0.647118937\n--- --Print the fractional portion of the timestamp for the first six readings in the buffer.\n--- --Example output:\n--- --0.647118937, 0.064543, 0.48196127, 0.89938724, 0.316800064, 0.734218263\n" - } - ], - "related_commands": [ - "bufferVar.seconds", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "30545.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();for x = 1, 3 do printbuffer(x, x, testData.readings, testData.sourcevalues, testData.relativetimestamps) end;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the three readings in testData, including the measurement, source value, and relative timestamp.\n--- --Output:\n--- ---9.6420389034124e-12, 2, 0\n--- ---4.5509945811872e-10, 2, 0.277194856\n--- ---9.1078204006445e-12, 2, 0.569614783\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "30550.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourceValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "This attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.The values returned by this command depend on the source readback state:", - "param_info": [ - { - "name": "sourceValue", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "sourceValue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.func = smu.FUNC_DC_CURRENT;smu.source.level = 1e-6;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 3, testData.sourcevalues);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source value to 1e-6\u00a0A.\n--- --Print the source values being output when readings in the reading buffer were acquired. \n--- --Example output:\n--- --9.9999874692e-07, 1.0000017028e-06, 1.0000054544e-06\n" - } - ], - "related_commands": [ - "bufferVar.sourcestatuses", - "bufferVar.sourceunits", - "bufferVar.statuses", - "bufferVar.formattedreadings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()", - "smu.source.readback" - ] - }, - { - "name": "tsplink.initialize()", - "webhelpfile": "30551.htm", - "signature": "tsplink.initialize(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes all instruments and enclosures in the TSP-Link system.", - "details": "If the only node on the TSP-Link network is the one running the command and expectedNodes is not provided, this function generates an error event. If you set expectedNodes to 1, the node is initialized.If you include expectedNodes, if nodesFound is less than expectedNodes, an error event is generated.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes found on the system, including the node on which the command is running", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 32)", - "enum": "", - "type": "integer", - "range": "(1 to 32)" - } - ], - "usage": [ - "nodesFound = tsplink.initialize()", - "nodesFound = tsplink.initialize(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.initialize()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.initialize(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link initialization and indicate how many nodes are found.\n--- --Example output if two nodes are found:Nodes found = 2\n--- --Example output if fewer nodes are found and if localnode.showevents = 7:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "related_commands": [ - "Initializing the TSP-Link system", - "localnode.showevents", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "eventlog.getcount()", - "webhelpfile": "30552.htm", - "signature": "eventlog.getcount(eventType)", - "command_return": "count", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of unread events in the event log.", - "details": "A count finds the number of unread events in the event log. You can specify the event types to return or return the count for all events.This command reports the number of events that have occurred since the command was last sent or since the event log was last cleared.Events are read automatically when localnode.showevents is enabled. You can also read them individually with eventlog.next().", - "param_info": [ - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventloggetcounteventType", - "range": "" - }, - { - "name": "count", - "description": "A count finds the number of unread events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = eventlog.getcount()", - "count = eventlog.getcount(eventType)" - ], - "overloads": [ - "count = eventlog.getcount()" - ], - "examples": [ - { - "example": "print(eventlog.getcount(eventlog.SEV_INFO));", - "description": "Displays the present number of unread information messages in the instrument event log.\n--- --If there are three information messages in the event log, output is:\n--- --3\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.next()", - "localnode.showevents" - ] - }, - { - "name": "trigger.timer[N].start.overrun", - "webhelpfile": "30553.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.", - "param_info": [ - { - "name": "state", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].start.overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].start.stimulus", - "webhelpfile": "30555.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the event that starts the trigger timer.", - "details": "Set the stimulus to any trigger event to start the timer when that event occurs.Set the stimulus to none to disable event processing and use the timer as a timer or alarm based on the start time.Trigger events are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event that starts the trigger timer; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.timer[N].start.stimulus", - "trigger.timer[N].start.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;trigger.timer[1].delay = 3e-3;trigger.timer[1].start.stimulus = trigger.EVENT_DIGIO3;", - "description": "Set digital I/O line 3 to be a trigger input.\n--- --Set timer 1 to delay for 3\u00a0ms.\n--- --Set timer 1 to start the timer when an event is detected on digital I/O line 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.configlist.store()", - "webhelpfile": "30559.htm", - "signature": "smu.measure.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active measure or digitize settings into the named configuration list.", - "details": "Use this command to store the active measure or digitize settings to a configuration index in a configuration list. If the index parameter is not provided, the new settings are appended to the end of the list. The index only stores the active settings for a single active measure or digitize function.A measure configuration list can store measure or digitize settings. If the active function is a digitize function, digitize settings are saved. When the index is queried, digitize settings and their values are listed, but measure settings are listed as not being used. Similarly, if the active function is a measure function, measure settings are saved. When the index is queried, the measure settings and their values are listed, but the digitize settings are listed as not used.Configuration lists are not saved when the instrument is turned off or reset. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Refer to Settings stored in a measure configuration index for a complete list of measure settings that the instrument stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.store(listName)", - "smu.measure.configlist.store(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.store(\"MyConfigList\");", - "description": "Stores the active settings of the instrument to the end of the configuration list MyConfigList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.unit", - "webhelpfile": "30560.htm", - "signature": "", - "command_return": "unitOfMeasure", - "type": "Attribute (RW)", - "default_value": "Current: smu.UNIT_AMPResistance: smu.UNIT_OHMVoltage: smu.UNIT_VOLT\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.", - "details": "The change in measurement units is displayed when the next measurement is made.", - "param_info": [ - { - "name": "unitOfMeasure", - "description": "The units of measure to be displayed for the measurement", - "enum": "smu.UNIT_AMP nil|smu.UNIT_OHM nil|smu.UNIT_VOLT nil|smu.UNIT_WATT nil", - "type": "smumeasureunitunitOfMeasure", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureunitfunction", - "range": "" - } - ], - "usage": [ - "unitOfMeasure = smu.measure.unit", - "smu.measure.unit = unitOfMeasure", - "unitOfMeasure = smu.measure.getattribute(function, ATTR_MEAS_UNIT)", - "smu.measure.setattribute(function, ATTR_MEAS_UNIT, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.unit = smu.UNIT_WATT;", - "description": "Changes the front-panel display and buffer readings for voltage measurements to be displayed as power readings in watts.\n" - } - ], - "related_commands": [ - "smu.measure.func" - ] - }, - { - "name": "smu.source.ilimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 105\u00a0\u00b5ACurrent: 7.35 V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2461 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the pulse source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.ilimit.level", - "smu.source.ilimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.vlimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 105\u00a0\u00b5ACurrent: 7.35 V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2461 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the pulse source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.vlimit.level", - "smu.source.vlimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.ilimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.ilimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.vlimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.vlimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.sweeplinear()", - "webhelpfile": "30563.htm", - "signature": "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear sweep for a fixed number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears any existing trigger models, creates a source configuration list, and populates the trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10\u00a0ms for the source delay and 25\u00a0ms for the sweep delay, the actual delay is 35\u00a0ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. ", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50\u00a0\u00b5s to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearrangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplineardual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.source.sweeplinear(\"VoltLinSweep\", 0, 10, 20, 1e-3, 1, smu.RANGE_FIXED);smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set up a linear sweep that sweeps from 0 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLinSweep.\n--- --Set the measure function to current.\n--- --Set the current range to 100 \u03bcA.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "smu.source.sweeplinearstep()", - "webhelpfile": "30565.htm", - "signature": "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear source sweep configuration list and trigger model with a fixed number of steps.", - "details": "When the sweep is started, the instrument sources a specific voltage or current voltage to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it deletes the existing trigger model and creates a trigger model with a uniform series of ascending or descending voltage or current changes, called steps. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the stop level, which is calculated from the number of steps. A measurement is performed at each source step (including the start and stop levels). At this level, the instrument performs another measurement and then stops the sweep.The instrument uses the step size parameter to determine the number of source level changes. The source level changes in equal steps from the start level to the stop level. To avoid a setting conflicts error, make sure the step size is greater than the start value and less than the stop value. To calculate the number of source-measure points in a sweep, use the following formula: Points = [(Stop - Start) / Step] + 1When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "step", - "description": "The step size at which the source level will change; must be more than 0", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearstepsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearstepcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearsteprangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 1;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;smu.source.sweeplinearstep(\"CurrLogSweep\", -1.05, 1.05, .25, 10e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to current.\n--- --Set the source range to 1\u00a0A. Set the measure function to voltage with a range of 20\u00a0V.\n--- --Set up a linear step sweep that sweeps from -1.05\u00a0A to 1.05\u00a0A in 0.25\u00a0A increments with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep CurrLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.sweeplog()", - "webhelpfile": "30566.htm", - "signature": "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a logarithmic sweep for a set number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears the existing trigger model and creates a new trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. The asymptote changes the inflection of the sweep curve and allows it to sweep through zero. You can use the asymptote parameter to customize the inflection and offset of the source value curve. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep. The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplogsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplogcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplograngeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "asymptote", - "description": "Default is 0; see Details", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)" - ], - "overloads": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;smu.source.sweeplog(\"VoltLogSweep\", 1, 10, 20, 1e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set the measure function to current.\n--- --Set the current range to 100 uA.\n--- --Set up a log sweep that sweeps from 1 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.clear()", - "webhelpfile": "30567.htm", - "signature": "status.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears event registers.", - "details": "This command clears the event registers of the Questionable Event and Operation Event Register set. It does not affect the Questionable Event Enable or Operation Event Enable registers.", - "param_info": [ - { - "name": "status.clear()", - "description": "Clear the bits in the registers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "status.clear();", - "description": "Clear the bits in the registers\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.getblocklist()", - "webhelpfile": "30569.htm", - "signature": "trigger.model.getblocklist()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the settings for all trigger model blocks.", - "details": "This returns the settings for the trigger model.", - "param_info": [ - { - "name": "output", - "description": "Returns the settings for the trigger model", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getblocklist()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.getblocklist());", - "description": "Returns the settings for the trigger model. Example output is:\n--- -- 1) BUFFER_CLEAR BUFFER: defbuffer1\n--- -- 2) MEASURE_DIGITIZE BUFFER: defbuffer1 INITIAL MODE: MEAS INITIAL COUNT: 1\n--- -- 3) BRANCH_COUNTER VALUE: 5 BRANCH_BLOCK: 2\n--- -- 4) DELAY_CONSTANT DELAY: 1.000000000\n--- -- 5) BRANCH_COUNTER VALUE: 3 BRANCH_BLOCK: 2\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()" - ] - }, - { - "name": "trigger.model.getbranchcount()", - "webhelpfile": "30570.htm", - "signature": "trigger.model.getbranchcount(blockNumber)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the count value of the trigger model counter block.", - "details": "This command returns the counter value. When the counter is active, this returns the present count. If the trigger model has started or is running but has not yet reached the counter block, this value is 0.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "output", - "description": "Returns the count value of the trigger model counter block.", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getbranchcount(blockNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 0.1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);trigger.model.initiate();delay(1);print(trigger.model.getbranchcount(4));waitcomplete();", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and make five readings.\n--- --Delay 0.1 s.\n--- --Loop ten more times back to block 2.\n--- --Send the count command to check which count has been completed for block 4.\n--- --At end of execution, 10 readings are stored in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.initiate()", - "webhelpfile": "30571.htm", - "signature": "trigger.model.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function starts the trigger model.", - "details": "", - "param_info": [], - "usage": [ - "trigger.model.initiate()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.model.abort()" - ] - }, - { - "name": " trigger.BLOCK_BUFFER_CLEAR", - "webhelpfile": "30574.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that clears the reading buffer.", - "details": "When trigger model execution reaches the buffer clear trigger block, the instrument empties the specified reading buffer. The specified buffer can be the default buffer or a buffer that you defined.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_BUFFER_CLEAR, capTest2);", - "description": "Assign trigger block 3 to buffer clear; when the trigger model reaches block 3, it clears the reading buffer named capTest2.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Buffer clear block" - ] - }, - { - "name": "trigger.timer[N].enable", - "webhelpfile": "30576.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables the trigger timer.", - "details": "When this command is set to on, the timer performs the delay operation.When this command is set to off, there is no timer on the delay operation.You must enable a timer before it can use the delay settings or the alarm configuration. For expected results from the timer, it is best to disable the timer before changing a timer setting, such as delay or start seconds.To use the timer as a simple delay or pulse generator with digital I/O lines, make sure the timer start time in seconds and fractional seconds is configured for a time in the past. To use the timer as an alarm, configure the timer start time in seconds and fractional seconds for the desired alarm time.", - "param_info": [ - { - "name": "state", - "description": "Disable the trigger timer", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerenablestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].enable", - "trigger.timer[N].enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].enable = trigger.ON;", - "description": "Enable the trigger timer for timer 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.logstate", - "webhelpfile": "30577.htm", - "signature": "bufferVar.logstate", - "command_return": "logState", - "type": "Attribute (RW)", - "default_value": "defbuffer1: buffer.ON (1)defbuffer2: buffer.ON (1)User-created buffer: buffer.OFF (0)\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if information events are logged when the specified reading buffer is at 0% or 100% filled.", - "details": "If this is set to on, when the reading buffer is cleared (0% filled) or full (100% filled), an event is logged in the event log. If this is set to off, reading buffer status is not reported in the event log.", - "param_info": [ - { - "name": "logState", - "description": "Do not log information events", - "enum": "buffer.OFF nil|buffer.ON nil", - "type": "bufferVarlogstatelogState", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "logState = bufferVar.logstate", - "bufferVar.logstate = logState" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;MyBuffer = buffer.make(500);print(MyBuffer.logstate);", - "description": "Create the user-defined buffer MyBuffer.\n--- --Print the log state of MyBuffer.\n--- --Output:\n--- --0\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.readback", - "webhelpfile": "30579.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument records the measured source value or the configured source value when making a measurement.", - "details": "When source readback is off, the instrument records and displays the source value you set. When you use the actual source value (source readback on), the instrument measures the actual source value immediately before making the measurement of the device under test.Using source readback results in more accurate measurements, but also a reduction in measurement speed.When source readback is on, the front-panel display shows the measured source value and the buffer records the measured source value immediately before the device-under-test measurement. When source readback is off, the front-panel display shows the configured source value and the buffer records the configured source value immediately before the device-under-test measurement.", - "param_info": [ - { - "name": "state", - "description": "Disable readback", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcereadbackstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcereadbackfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.readback", - "smu.source.readback = state", - "state = smu.source.getattribute(function, ATTR_SRC_READBACK)", - "smu.source.setattribute(function, ATTR_SRC_READBACK, state)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testDataBuffer = buffer.make(100);smu.source.func = smu.FUNC_DC_VOLTAGE;smu.measure.func = smu.FUNC_DC_CURRENT;smu.source.readback = smu.ON;smu.source.level = 10;smu.measure.count = 100;smu.source.output = smu.ON;smu.measure.read(testDataBuffer);smu.source.output = smu.OFF;printbuffer(1, 100, testDataBuffer.sourcevalues, testDataBuffer);", - "description": "Reset the instrument to default settings.\n--- --Make a buffer named testDataBuffer that can hold 100 readings.\n--- --Set source function to voltage.\n--- --Set the measurement function to current.\n--- --Set read back on.\n--- --Set the instrument to take 100 readings.\n--- --Turn the output on.\n--- --Take the measurements.\n--- --Turn the output off.\n--- --Get the source values and measurements from the buffer.\n" - } - ], - "related_commands": [ - "smu.measure.func", - "smu.source.func" - ] - }, - { - "name": "smu.source.highc", - "webhelpfile": "30580.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When the instrument is measuring low current and is driving a capacitive load, you may see overshoot, ringing, and instability. You can enable the high capacitance mode to minimize these problems.", - "param_info": [ - { - "name": "state", - "description": "Turn high-capacitance mode off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcehighcstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcehighcfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.highc", - "smu.source.highc = state", - "state = smu.source.getattribute(function, ATTR_SRC_HIGHC)", - "smu.source.setattribute(function, ATTR_SRC_HIGHC, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.highc = smu.ON;", - "description": "Turn the high capacitance mode on.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - DurationLoop", - "webhelpfile": "30588.htm", - "signature": "trigger.model.load(DurationLoop, duration, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements for a specified amount of time.", - "details": "When you load this trigger-model template, you can specify amount of time to make a measurement and the length of the delay before the measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "DurationLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "duration", - "description": "The amount of time for which to make measurements (167 ns to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(167 ns to 100\u00a0ks)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)", - "trigger.model.load(DurationLoop, duration, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 5; ;-- Turn on output, initiate readings, and store them in defbuffer1;trigger.model.load(\"DurationLoop\", 10, 0.01, defbuffer1);trigger.model.initiate();", - "description": "Reset the instrument. Set the instrument to source voltage at 5\u00a0V. Set to measure current.\n--- --Load the duration loop trigger model to take measurements for 10 s with a 10\u00a0ms delay before each measurement.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "30981.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines.", - "details": "This function writes to the digital I/O port by setting the binary state of each digital line from an integer equivalent value.The binary representation of the value indicates the output pattern to be written to the I/O port. For example, a value of 63 has a binary equivalent of 111111 (all lines are set high); a data value of 42 has a binary equivalent of 101010 (lines 2, 4, and 6 are set high, and the other three lines are set low).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.You can also enter the data parameter as a binary value.", - "param_info": [ - { - "name": "data", - "description": "The value to write to the port (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(63);", - "description": "Sets digital I/O lines 1 through 6 high (binary 111111).\n" - }, - { - "example": "digio.writeport(0b111111);", - "description": "Sets digital I/O lines 1 through 6 high (digital\u00a063).\n" - } - ], - "related_commands": [ - "digio.readport()", - "Outputting a bit pattern" - ] - }, - { - "name": "digio.line[N].state", - "webhelpfile": "30982.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low when the line is set for digital control and returns the state on the digital I/O lines.", - "details": "When a reset occurs, the digital line state can be read as high because the digital line is reset to a digital input. A digital input floats high if nothing is connected to the digital line.This returns the integer equivalent values of the binary states on all six digital I/O lines.Set the state to digio.STATE_LOW to clear the bit; set the state to digio.STATE_HIGH to set the bit.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "state", - "description": "Set the line low", - "enum": "digio.STATE_LOW nil|digio.STATE_HIGH nil", - "type": "digiolinestatestate", - "range": "" - } - ], - "usage": [ - "digio.line[N].state = state", - "state = digio.line[N].state" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_DIGITAL_OUT;digio.line[1].state = digio.STATE_HIGH;", - "description": "Sets line 1 (bit B1) of the digital I/O port high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.readport()", - "digio.writeport()", - "trigger.digin[N].edge" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "31076.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger timer settings to their default values.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their default values:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 to their default values.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].enable", - "trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.generate", - "trigger.timer[N].start.overrun", - "trigger.timer[N].start.seconds", - "trigger.timer[N].start.stimulus" - ] - }, - { - "name": " trigger.BLOCK_WAIT", - "webhelpfile": "31093.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that waits for an event before allowing the trigger model to continue.", - "details": "The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger block allows trigger execution to continue (see Details)", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "(see Details)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITclear", - "range": "" - }, - { - "name": "logic", - "description": "If each event must occur before the trigger model continues", - "enum": "trigger.WAIT_AND nil|trigger.WAIT_OR nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITlogic", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)" - ], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);", - "description": "Set trigger model block 9 to wait for a user to press the TRIGGER key on the front panel before continuing.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_MEASURE_DIGITIZE", - "webhelpfile": "31094.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that makes or digitizes a measurement.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "count", - "description": "The number of measure or digitize readings to make before moving to the next block in the trigger model; set to", - "enum": "trigger.COUNT_INFINITE nil|trigger.COUNT_STOP nil|trigger.COUNT_AUTO nil", - "type": "triggermodelsetblocktriggerBLOCK_MEASURE_DIGITIZEcount", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set the function to measure DC voltage.\n--- --Set block 1 to clear defbuffer1.\n--- --Set block 2 to set a delay of 0.\n--- --Set block 3 to make measurements infinitely.\n--- --Set block 4 to wait until the front-panel TRIGGER key is pressed.\n--- --Set block 5 to stop making measurements.\n--- --Set block 6 to send a notification.\n--- --Start the trigger model.\n--- --You must press the front-panel TRIGGER key to stop measurements.\n--- --Output the number of readings.\n" - }, - { - "example": "reset();smu.measure.configlist.create(\"countactive\");smu.measure.count = 2;smu.measure.configlist.store(\"countactive\") -- index1;smu.measure.count = 10;smu.measure.configlist.store(\"countactive\") -- index2;smu.measure.count = 3;smu.measure.configlist.store(\"countactive\") -- index3;\u00a0;trigger.model.setblock(1, trigger.BLOCK_CONFIG_NEXT, \"countactive\");trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_AUTO);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 3, 1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set up a configuration list named countactive.\n--- --Set the measure count to 2 (replace smu.measure.count with smu.digitize.count if using a digitize function.)\n--- --Store the count in index 1.\n--- --Set the measure count to 10.\n--- --Store the count in index 2.\n--- --Set the measure count to 3.\n--- --Store the count in index 3.\n--- --Set up trigger model block 1 to call the next index from the countactive configuration list.\n--- --Set block 2 to measure or digitize and store the readings in defbuffer1, using the most recent count value.\n--- --Set block 3 to add a delay of 1\u00a0s.\n--- --Set block 4 to iterate through the trigger model 3 times, returning to block 1.\n--- --Start the trigger model.\n--- --Output the number of readings. There should be 15 readings.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Measure/Digitize block" - ] - }, - { - "name": " trigger.BLOCK_SOURCE_OUTPUT", - "webhelpfile": "31095.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that turns the output source on or off.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "Turn the source off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "triggermodelsetblocktriggerBLOCK_SOURCE_OUTPUTstate", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);", - "description": "Set trigger model to turn the source on when it reaches block 2.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_RECALL", - "webhelpfile": "31096.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the system settings that are stored in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.When the trigger model reaches a configuration recall block, the settings in the specified configuration list are recalled if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are recalled from the next index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.You can restore a specific set of configuration settings in the configuration list by defining the index.If you need to swap the source and measure configuration lists, you need to delete this block and create a new Config List Recall block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list to recall; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalIndex", - "description": "The index to recall from the second configuration list; defaults to 1", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5);", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5,; \"sourTrigList\") ;print(trigger.model.getblocklist());", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList and load index 1 from the configuration list name sourTrigList.\n--- --Query the configuration of the block.\n--- --Output:\n--- --5) CONFIG_RECALL CONFIG_LIST: measTrigList and sourTrigList INDEX: 5 and 1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_NEXT", - "webhelpfile": "31097.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the settings at the next index of a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "The name of the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");", - "description": "Configure trigger block 5 to load the next index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\");trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 1 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 1\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_NEXT CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the next index in both the configuration list named measTrigList and the configuration list named sourTrigList. \n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_PREV", - "webhelpfile": "31098.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.The Config List Prev block defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are each recalled from the previous index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.The configuration list previous index trigger block type recalls the previous index in a configuration list. It configures the source or measure settings of the instrument based on the settings at that index. The trigger model executes the settings at that index before the next block is executed.The first time the trigger model encounters this block, the last index in the configuration list is recalled if the list has not already had an index recalled by the recall block command in an earlier trigger model block. If the configuration list has recalled an index with the recall block, the previous index in the list is called instead of the last. For example, the recall block recalls index 1 by default, so if the trigger model uses a recall block before this one, the first time the previous block is reached after that recall, the last index is recalled. However, if the recall block recalled index 3, the previous block would recall index 2. Each subsequent time trigger model execution reaches a configuration list previous block for this configuration list, it goes backward one index. When the first index in the list is reached, it goes to the last index in the configuration list.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(8, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");", - "description": "Configure trigger block 8 to load the previous index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 3);trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 3 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Then, recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 3\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_PREV CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_PREV, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the previous index in both the configuration list named measTrigList and the configuration list named sourTrigList.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_DELAY_DYNAMIC", - "webhelpfile": "31101.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a user delay to the execution of the trigger model.", - "details": "Each measure function can have up to five unique user delay times (M1 to M5). Digitize user delays are handled as measure user delays, so you can have a total of five measure and digitize user delays. Each source function can also have up to five unique user delay times (S1 to S5). The delay time is set by the user-delay command, which is only available over a remote interface. Though the trigger model can be used with any function, the user delay is set per function. Make sure you are setting the delay for the function you intend to use with the trigger model.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "userDelay", - "description": "The number of the user delay", - "enum": "trigger.USER_DELAY_M nil|trigger.USER_DELAY_S nil", - "type": "triggermodelsetblocktriggerBLOCK_DELAY_DYNAMICuserDelay", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "smu.measure.userdelay[N]", - "smu.source.userdelay[N]" - ] - }, - { - "name": " trigger.BLOCK_DIGITAL_IO", - "webhelpfile": "31102.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that sets the lines on the digital I/O port high or low.", - "details": "The bit mask defines the bits in the pattern that are driven high or low. A binary 1 in the bit mask indicates that the corresponding I/O line should be driven according to the bit pattern. To drive all lines, specify all ones (63, 0x3F, 0b111111) or omit this parameter. If the bit for a line in the bit pattern is set to 1, the line is driven high. If the bit is set to 0 in the bit pattern, the line is driven low.For this block to work as expected, make sure you configure the trigger type and line state of the digital line for use with the trigger model (use the digital line mode command).", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bitPattern", - "description": "Sets the value that specifies the output line bit pattern (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - }, - { - "name": "bitMask", - "description": "Specifies the bit mask; if omitted, all lines are driven (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)" - ], - "overloads": [], - "examples": [ - { - "example": "for x = 3, 6 do digio.line[x].mode = digio.MODE_DIGITAL_OUT end;trigger.model.setblock(4, trigger.BLOCK_DIGITAL_IO, 20, 60);", - "description": "The for loop configures digital I./O lines 3 through 6 as digital outputs. Trigger block 4 is then configured with a bit pattern of 20 (digital I/O lines 3 and 5 high). The optional bit mask is specified as 60 (lines 3 through 6), so both lines 3 and 5 are driven high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_COUNTER", - "webhelpfile": "31103.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that branches to a specified block a specified number of times.", - "details": "This command defines a trigger model building block that branches to another block using a counter to iterate a specified number of times.Counters increment every time the trigger model reaches them until they are more than or equal to the count value. At that point, the trigger model continues to the next building block in the sequence.The counter is reset to 0 when the trigger model starts. It is incremented each time trigger model execution reaches the counter block.If you are using remote commands, you can query the counter. The counter is incremented immediately before the branch compares the actual counter value to the set counter value. Therefore, the counter is at 0 until the first comparison. When the trigger model reaches the set counter value, branching stops and the counter value is one greater than the setting. Use trigger.model.getbranchcount() to query the counter.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetCount", - "description": "The number of times to repeat", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the counter is less than the targetCount value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);print(trigger.model.getbranchcount(4));", - "description": "When the trigger model reaches this block, the trigger model returns to block 2. This repeats 10 times.\n--- --An example of the return if the trigger model has reached this block 5 times is:\n--- --5\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_RESET_BRANCH_COUNT" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ON_EVENT", - "webhelpfile": "31104.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function branches to a specified block when a specified trigger event occurs.", - "details": "If you are using a timer, it must be started before it can expire. One method to start the timer in the trigger model is to include a Notify block before the On Event block. Set the Notify block to use the same timer as the On Event block.The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger model branches the specified block", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the specified event occurs", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ON_EVENT, trigger.EVENT_DISPLAY, 2);", - "description": "When the trigger model reaches this block, if the front-panel TRIGGER key has been pressed, the trigger model returns to block 2. If the TRIGGER key has not been pressed, the trigger model continues to block 7 (the next block in the trigger model).\n" - } - ], - "related_commands": [ - "On event block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_CONSTANT", - "webhelpfile": "31105.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if a measurement meets preset criteria.", - "details": "The type of limit can be:The measurement block must be a measure/digitize block that occurs in the trigger model before the branch-on-constant-limits block. The last measurement from a measure/digitize block is used.If the limit A is more than the limit B, the values are automatically swapped so that the lesser value is used as the lower limit.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitType", - "range": "" - }, - { - "name": "limitA", - "description": "The lower limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitA", - "range": "" - }, - { - "name": "limitB", - "description": "The upper limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitB", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the defined criteria", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, trigger.LIMIT_ABOVE, 0.1, 1, 2);", - "description": "Sets trigger block 5 to be a constant limit that branches to block 2 when the measurement is above the value set for limit B (which is set to 1). Note that limit A must be set but is ignored. \n" - } - ], - "related_commands": [ - "Constant Limit block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_DELTA", - "webhelpfile": "31107.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.", - "details": "This block calculates the difference between the last two measurements from a measure/digitize block. It subtracts the most recent measurement from the previous measurement.The difference between the measurements is compared to the target difference. If the difference is less than the target difference, the trigger model goes to the specified branching block. If the difference is more than the target difference, the trigger model proceeds to the next block in the trigger block sequence.If you do not define the measure/digitize block, it will compare measurements of a measure/digitize block that precedes the branch delta block. For example, if you have a measure/digitize block, a wait block, another measure/digitize block, another wait block, and then the branch delta block, the delta block compares the measurements from the second measure/digitize block. If a preceding measure/digitize block does not exist, an error occurs.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetDifference", - "description": "The value against which the block compares the difference between the measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the difference between the measurements is less than or equal to the targetDifference", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_DELTA, 0.35, 8, 3);", - "description": "Configure trigger block 5 to branch to block 8 when the measurement difference from block 3 is less than 0.35.\n" - } - ], - "related_commands": [ - "Delta block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE", - "webhelpfile": "31108.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.", - "details": "The branch-once building block branches to a specified block the first time trigger model execution encounters the branch-once block. If it is encountered again, the trigger model ignores the block and continues in the normal sequence.The once block is reset when trigger model execution reaches the idle state. Therefore, the branch-once block always executes the first time the trigger model execution encounters this block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model first encounters this block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE, 4);", - "description": "When the trigger model reaches block 2, the trigger model goes to block 4 instead of going in the default sequence of block 3.\n" - } - ], - "related_commands": [ - "Once block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE_EXCLUDED", - "webhelpfile": "31109.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.", - "details": "The branch-once-excluded block is ignored the first time the trigger model encounters it. After the first encounter, the trigger model goes to the specified branching block.The branch-once-excluded block is reset when the trigger model starts or is placed in idle.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model encounters this block after the first encounter", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, 4);", - "description": "When the trigger model reaches block 2 the first time, the trigger model goes to block 3. If the trigger model reaches this block again, the trigger model goes to block 4.\n" - } - ], - "related_commands": [ - "Once excluded block" - ] - }, - { - "name": " trigger.BLOCK_NOTIFY", - "webhelpfile": "31110.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that generates a trigger event and immediately continues to the next block.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "The identification number of the notification; 1 to 8", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.model.setblock(5, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY2);trigger.digout[3].stimulus = trigger.EVENT_NOTIFY2;", - "description": "Define trigger model block 5 to be the notify 2 event. Assign the notify 2 event to be the stimulus for digital output line 3.\n" - } - ], - "related_commands": [ - "Notify block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ALWAYS", - "webhelpfile": "31112.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that always goes to a specific block.", - "details": "When the trigger model reaches a branch-always building block, it goes to the building block set by branchToBlock.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number to execute when the trigger model reaches the Branch Always block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ALWAYS, 20);", - "description": "When the trigger model reaches block 6, always branch to block 20.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_DYNAMIC", - "webhelpfile": "31114.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.", - "details": "The measure/digitize block must occur in the trigger model before the branch-on-dynamic-limits block. If no block is defined, the measurement from the previous measure/digitize block is used. If no previous measure/digitize block exists, an error is reported.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_DYNAMIClimitType", - "range": "" - }, - { - "name": "limitNumber", - "description": "The limit number (1 or 2)", - "enum": "", - "type": "1|2", - "range": "(1 or 2)" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the criteria set in the configuration list", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, trigger.LIMIT_OUTSIDE, 2, 10, 5);", - "description": "Configure block 7 to check if limit 2 is outside its limit values, based on the measurements made in block 5. If values are outside the measurements, branch to block 10. If the values are not outside the measurements, trigger model execution continues to block 8.\n" - } - ], - "related_commands": [ - "Dynamic Limit block", - "smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].high.value" - ] - }, - { - "name": " trigger.BLOCK_DELAY_CONSTANT", - "webhelpfile": "31347.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a constant delay to the execution of a trigger model.", - "details": "When trigger model execution reaches a delay block, it stops normal measurement and trigger model operation for the time set by the delay. Background measurements continue to be made, and if any previously executed block started infinite measurements, they also continue to be made.If other delays have been set, this delay is in addition to the other delays.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "time", - "description": "The amount of time to delay in seconds (167 ns to 10 ks, or 0 for no delay)", - "enum": "", - "type": "number", - "range": "(167 ns to 10 ks, or 0 for no delay)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_DELAY_CONSTANT, 30e-3);", - "description": "Configure trigger block 7 to delay the trigger model before the next block until a delay of 30 ms elapses.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digin[N].edge", - "webhelpfile": "31360.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the edge used by the trigger event detector on the given trigger line.", - "details": "This command sets the logic on which the trigger event detector and the output trigger generator operate on the specified trigger line.To directly control the line state, set the mode of the line to digital and use the write command. When the digital line mode is set for open drain, the edge settings assert a TTL low-pulse.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger logic value", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggerdiginedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "detectedEdge = trigger.digin[N].edge", - "trigger.digin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;trigger.digin[4].edge = trigger.EDGE_RISING;", - "description": "Sets the trigger mode for digital I/O line\u00a04 to detect a rising-edge trigger as an input.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "digio.writeport()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "digio.line[N].mode", - "webhelpfile": "31363.htm", - "signature": "", - "command_return": "lineMode", - "type": "Attribute (RW)", - "default_value": "digio.MODE_DIGITAL_IN\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode of the digital I/O line to be a digital line, trigger line, or synchronous line and sets the line to be input, output, or open-drain.", - "details": "", - "param_info": [ - { - "name": "lineMode", - "description": "The digital line control type and line mode", - "enum": "digio.MODE_DIGITAL_IN nil|digio.MODE_DIGITAL_OUT nil|digio.MODE_DIGITAL_OPEN_DRAIN nil|digio.MODE_TRIGGER_IN nil|digio.MODE_TRIGGER_OUT nil|digio.MODE_TRIGGER_OPEN_DRAIN nil|digio.MODE_SYNCHRONOUS_MASTER nil|digio.MODE_SYNCHRONOUS_ACCEPTOR nil", - "type": "digiolinemodelineMode", - "range": "" - }, - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "lineMode = digio.line[N].mode", - "digio.line[N].mode = lineMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_TRIGGER_OUT;", - "description": "Set digital I/O line 1 to be an output trigger line.\n" - } - ], - "related_commands": [ - "trigger.digin[N].edge" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "31368.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the digital I/O port. The least significant bit (bit B1) of the binary number corresponds to digital I/O line 1; bit B6 corresponds to digital I/O line 6.For example, a returned value of 42 has a binary equivalent of 101010, which indicates that lines 2, 4, 6 are high (1), and the other lines are low (0).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, and 6 are set high when the I/O port is read.\n--- --Output:\n--- --42\n--- --This is binary 101010\n" - } - ], - "related_commands": [ - "digio.writeport()" - ] - }, - { - "name": "trigger.digin[N].clear()", - "webhelpfile": "31373.htm", - "signature": "trigger.digin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital input line.", - "details": "The event detector of a trigger enters the detected state when an event is detected. For the specified trigger line, this command clears the event detector, discards the history, and clears the overrun status(sets the overrun status to false).", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.digin[2].clear();", - "description": "Clears the trigger event detector on I/O line\u00a02.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digin[N].wait()" - ] - }, - { - "name": "trigger.digin[N].overrun", - "webhelpfile": "31378.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "overrun = trigger.digin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.digin[1].overrun;print(overrun);", - "description": "If there is no trigger overrun on digital input\u00a01, the output is:\n--- --false\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].pulsewidth", - "webhelpfile": "31385.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0us)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use trigger.digout[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "width = trigger.digout[N].pulsewidth", - "trigger.digout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digout[N].assert()", - "trigger.digout[N].release()" - ] - }, - { - "name": "trigger.digout[N].assert()", - "webhelpfile": "31392.htm", - "signature": "trigger.digout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines.", - "details": "Initiates a trigger event and does not wait for completion. The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].pulsewidth = 20e-6;trigger.digout[2].assert();", - "description": "Asserts a trigger on digital I/O line 2 with a pulse width of 20\u00a0us.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "digio.line[N].reset()", - "webhelpfile": "31393.htm", - "signature": "digio.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets digital I/O line values to their factory defaults.", - "details": "This function resets the following attributes to their default values:It also clears trigger.digin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "digio.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "-- Set the digital I/O trigger line 3 for a falling edge;digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.digout[3].logic = trigger.LOGIC_NEGATIVE;-- Set the digital I/O trigger line 3 to have a pulsewidth of 50 microseconds.;trigger.digout[3].pulsewidth = 50e-6;-- Use digital I/O line 5 to trigger the event on line 3.;trigger.digout[3].stimulus = trigger.EVENT_DIGIO5;-- Print configuration (before reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);-- Reset the line back to factory default values.;digio.line[3].reset();-- Print configuration (after reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);", - "description": "Output before reset:\n--- --digio.MODE_TRIGGER_OUT 5e-05 trigger.EVENT_DIGIO5\n--- --\u00a0\n--- --Output after reset:\n--- --digio.MODE_TRIGGER_IN 1e-05 trigger.EVENT_NONE\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digout[N].pulsewidth", - "trigger.digout[N].stimulus" - ] - }, - { - "name": "trigger.digin[N].wait()", - "webhelpfile": "31394.htm", - "signature": "trigger.digin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time trigger.digin[N].wait() or trigger.digin[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and is ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detected", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.digin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;triggered = trigger.digin[4].wait(3);print(triggered);", - "description": "Waits up to 3 s for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].release()", - "webhelpfile": "31395.htm", - "signature": "trigger.digout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].assert()", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "trigger.lanout[N].assert()", - "webhelpfile": "31396.htm", - "signature": "trigger.lanout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].assert();", - "description": "Creates a trigger with LAN trigger 5.\n" - } - ], - "related_commands": [ - "lan.lxidomain", - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].wait()", - "webhelpfile": "31397.htm", - "signature": "trigger.lanin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time trigger.lanin[N].wait() or trigger.lanin[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.lanin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.lanin[5].wait(3);", - "description": "Wait for a trigger event with LAN trigger 5 with a timeout of 3\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].clear()", - "webhelpfile": "31398.htm", - "signature": "trigger.lanin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[5].clear();", - "description": "Clears the event detector with LAN event trigger 5.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun" - ] - }, - { - "name": "trigger.lanout[N].connect()", - "webhelpfile": "31401.htm", - "signature": "trigger.lanout[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;trigger.lanout[1].connect();trigger.lanout[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].disconnect()", - "webhelpfile": "31404.htm", - "signature": "trigger.lanout[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger event generator.", - "details": "When this command is set for TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].disconnect()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].connected", - "webhelpfile": "31406.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN event connection state.", - "details": "This is set to true when the LAN trigger is connected and ready to send trigger events after a successful trigger.lanout[N].connect() command. If the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attribute is changed or when the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = trigger.lanout[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;print(trigger.lanout[1].connected);", - "description": "Outputs true if connected, or false if not connected.\n--- --Example output:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].ipaddress", - "webhelpfile": "31409.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted-decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.After you change this setting, you must send the connect command before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = trigger.lanout[N].ipaddress", - "trigger.lanout[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[3].protocol = lan.PROTOCOL_TCP;trigger.lanout[3].ipaddress = \"192.0.32.10\";trigger.lanout[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be TCP when sending LAN triggers.\n--- --Use IP address \"192.0.32.10\" to connect the LAN trigger.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()" - ] - }, - { - "name": "trigger.lanin[N].overrun", - "webhelpfile": "31413.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.lanin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.lanin[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].protocol", - "webhelpfile": "31416.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "lan.PROTOCOL_TCP\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all the supported protocols. However, it uses the designated protocol for sending outgoing messages.After you change this setting, you must re-connect the LAN trigger event generator before you can send outgoing event messages.When multicast is selected, the trigger IP address is ignored, and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.PROTOCOL_TCP nil|lan.PROTOCOL_UDP nil|lan.PROTOCOL_MULTICAST nil", - "type": "triggerlanoutprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = trigger.lanout[N].protocol", - "trigger.lanout[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.lanout[1].protocol);", - "description": "Get LAN protocol that is being used for sending trigger messages for LAN event 1.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "trigger.lanout[N].stimulus", - "webhelpfile": "31419.htm", - "signature": "", - "command_return": "LANevent", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set the event to one of the existing trigger events, which are shown in the following table.Setting this attribute to none disables automatic trigger generation.If any events are detected before the trigger LAN connection is sent, the event is ignored, and the action overrun is set.", - "param_info": [ - { - "name": "LANevent", - "description": "The LAN event that causes this trigger to assert; see Details for values", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "LANevent = trigger.lanout[N].stimulus", - "trigger.lanout[N].stimulus = LANevent" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].stimulus = trigger.EVENT_TIMER1;", - "description": "Use the timer 1 trigger event as the source for LAN trigger 5 stimulus.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "smu.measure.userdelay[N]", - "webhelpfile": "31441.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay (0 for no delay, or 167\u00a0ns to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 for no delay, or 167\u00a0ns to 10 ks)" - }, - { - "name": "N", - "description": "The user delay to which this time applies (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The measurement function; see Functions", - "enum": "", - "type": "smumeasureuserdelayfunction", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.measure.userdelay[N]", - "smu.measure.userdelay[N] = delayTime", - "delayTime = smu.measure.getattribute(function, ATTR_MEAS_USER_DELAY_N)", - "smu.measure.setattribute(function, ATTR_MEAS_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "smu.measure.readwithtime()", - "webhelpfile": "31457.htm", - "signature": "smu.measure.readwithtime()", - "command_return": "reading, seconds, fractional", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates measurements and returns the last actual measurement and time information in UTC format without using the trigger model.", - "details": "This command initiates measurements using the present function setting, stores the readings in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "seconds", - "description": "Seconds in UTC format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractional", - "description": "Fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading, seconds, fractional = smu.measure.readwithtime()", - "smu.measure.readwithtime(bufferName)" - ], - "overloads": [ - "smu.measure.readwithtime(bufferName)" - ], - "examples": [ - { - "example": "print(smu.measure.readwithtime(defbuffer1));", - "description": "Print the last measurement and time information from defbuffer1 in UTC format, which will look similar to:\n--- ---1.405293589829e-11 1400904629 0.1950935\n" - } - ], - "related_commands": [ - "smu.measure.count", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.source.sweeplist()", - "webhelpfile": "31499.htm", - "signature": "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a sweep based on a configuration list, which allows you to customize the sweep.", - "details": "This command allows you to set up a custom sweep, using a configuration list to specify the source levels.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.To run the sweep, initiate the trigger model.You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list where the sweep starts; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is 0 for no delay or you can set a specific delay value from 50 us to 10 ks", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplistcount | integer", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplistfailAbort", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)" - ], - "overloads": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"CurrListSweep\");smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 100e-3;smu.source.level = 1e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 10e-6;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 7e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 11e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 9e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.sweeplist(\"CurrListSweep\", 1, 0.001);smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;trigger.model.initiate();", - "description": "Reset the instrument to its defaults\n--- --Create a source configuration list called CurrListSweep.\n--- --Set the source function to current.\n--- --Set the source current range to 100\u00a0mA.\n--- --Set the source current level to 1\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 10\u00a0uA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 7\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 11\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 9\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set up a list sweep that uses the entries from the CurrListSweep configuration list and starts at index 1 of the list.\n--- --Set a source delay of 1\u00a0ms.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.questionable.setmap()", - "webhelpfile": "31612.htm", - "signature": "status.questionable.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function maps events to bits in the questionable event registers.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.questionable.setmap(bitNumber, setEvent)", - "status.questionable.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.questionable.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.questionable.setmap(0, 4917, 4918);", - "description": "When event 4917 (a default buffer is 0% filled) occurs, bit 0 is set in the condition register and the event register of the Questionable Event Register. When event 4918 (a default buffer is 100% filled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "status.questionable.getmap()" - ] - }, - { - "name": "status.questionable.getmap()", - "webhelpfile": "31613.htm", - "signature": "status.questionable.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Questionable Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - } - ], - "usage": [ - "setEvent, clearEvent = status.questionable.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.getmap(9));", - "description": "Returns the events that were mapped to set and clear bit 9.\n" - } - ], - "related_commands": [ - "Questionable Event Register", - "status.questionable.setmap()" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "31614.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Condition Register of the status model.", - "details": "This command reads the contents of the Questionable Condition Register, which is one of the Questionable Event Registers.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.condition);", - "description": "Reads the Questionable Condition Register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "31615.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the questionable event enable register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Questionable Event Register.When one of these bits is set, when the corresponding bit in the Questionable Event Register or Questionable Condition Register is set, the MSB and QSM bits in the Status Byte Register are set.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.enable", - "status.questionable.enable = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = 17;print(status.questionable.enable);", - "description": "Set bits 0 and 4 of the Questionable Event Enable Register.\n--- --Returns 17, which indicates the register was set correctly.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.condition", - "webhelpfile": "31635.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "You can use this command to read the status byte, which is returned as a numeric value. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence. The returned value can indicate that one or more status events occurred. If more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).The meanings of the individual bits of this register are shown in the following table.", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Example output:\n--- --1.2900000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "31637.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the Operation Event Enable Register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Operation Event Register.When one of these bits is set, when the corresponding bit in the Operation Event Register or Operation Condition Register is set, the OSB bit in the Status Byte Register is set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.enable", - "status.operation.enable = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Sets the 12 and 14 bits of the operation status enable register using a decimal value.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "31638.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This attribute reads the operation event register of the status model.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.event" - ], - "overloads": [], - "examples": [ - { - "example": "status.request_enable = status.OSB ;status.operation.setmap(0, 4918, 4917);status.operation.enable = 1;defbuffer1.clear();defbuffer1.fillmode = buffer.FILL_ONCE;defbuffer1.capacity = 10;smu.measure.count = 10;smu.measure.read();print(status.operation.event);", - "description": "Set bits in the Status Request Enable Register to record an enabled event in the Operation Status Register.\n--- --Map event number 4918 (a default buffer is full) to set bit 0 in the Operation Event Register and event number 4917 (a default buffer is empty) to clear bit 0.\n--- --Clear defbuffer1.\n--- --Set defbuffer1 to fill once.\n--- --Resizes defbuffer1 to 10 readings. \n--- --Sets the measure count to 10 readings and makes a measurement. \n--- --Reads the operation event register.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "31639.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This command reads the contents of the Operation Condition Register, which is one of the Operation Event Registers.For detail on interpreting the value of a register, see Understanding bit settings.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.condition);", - "description": "Returns the contents of the register.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.setmap()", - "webhelpfile": "31648.htm", - "signature": "status.operation.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to map events to bits in the Operation Event Register.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.operation.setmap(bitNumber, setEvent)", - "status.operation.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.operation.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.operation.setmap(0, 2731, 2732);", - "description": "When event 2731 (trigger model initiated) occurs, bit 0 in the condition and event registers of the Operation Event Register are set. When event 2732 (trigger model idled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "Operation Event Register", - "Programmable status register sets", - "status.operation.getmap()" - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "31653.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the contents of the Standard Event Status Register set of the status model.", - "details": "When this command returns zero (0), no bits are set. You can send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "standardRegister = status.standard.event" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.standard.event);", - "description": "May return the value 129, showing that the Standard Event Status Register contains binary 10000001\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "32386.htm", - "signature": "", - "command_return": "SRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the settings of the Service Request (SRQ) Enable Register.", - "details": "This command sets or clears the individual bits of the Status Request Enable Register.The Status Request Enable Register is cleared when power is cycled or when a parameter value of 0 is sent with this command.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "SRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings (0 to 255)", - "enum": "", - "type": "integer", - "range": "(SRQ)" - } - ], - "usage": [ - "SRQEnableRegister = status.request_enable", - "status.request_enable = SRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register and clear all other bits.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits and clear all other bits of the service request (SRQ) enable register.\n" - }, - { - "example": "status.request_enable = 0;", - "description": "Clear the register.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.gettime()", - "webhelpfile": "32416.htm", - "signature": "localnode.gettime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the instrument date and time.", - "details": "The time is returned in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "print(os.date('%c', gettime()))", - "description": "Example output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "print(os.date('%c', gettime()));", - "description": "Example output:\n--- --Tue Dec 5 03:44:37 2017\n" - } - ], - "related_commands": [ - "localnode.settime()" - ] - }, - { - "name": "tsplink.line[N].mode", - "webhelpfile": "32538.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "tsplink.MODE_DIGITAL_OPEN_DRAIN\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation of a TSP-Link line.", - "details": "This command defines whether or not the line is used as a digital or trigger control line and if it is an input or output.The line mode can be set to the following options:", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode; see Details", - "enum": "", - "type": "tsplinkLineMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.line[N].mode", - "tsplink.line[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;", - "description": "Sets the trigger mode for synchronization line 3 as a trigger open drain line.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkout[N].logic" - ] - }, - { - "name": "trigger.tsplinkin[N].edge", - "webhelpfile": "32539.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates which trigger edge controls the trigger event detector for a trigger line.", - "details": "When the edge is detected, the instrument asserts a TTL-low pulse for the output.The output state of the I/O line is controlled by the trigger logic. The user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger mode", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggertsplinkinedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "detectedEdge = trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[3].edge = trigger.EDGE_RISING;", - "description": "Sets synchronization line 3 to detect rising edge triggers as input.\n" - } - ], - "related_commands": [ - "digio.writeport()", - "tsplink.line[N].mode", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkout[N].logic", - "webhelpfile": "32540.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger output with output logic for a trigger line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggertsplinkoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "logicType = trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].logic = trigger.LOGIC_POSITIVE;", - "description": "Sets the trigger logic for synchronization line 3 to output a positive pulse.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].reset()", - "webhelpfile": "32541.htm", - "signature": "tsplink.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults.", - "details": "The tsplink.line[N].reset() function resets the following attributes to their default values:This also clears trigger.tsplinkin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes to default values.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].overrun", - "trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].stimulus", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].state", - "webhelpfile": "32542.htm", - "signature": "", - "command_return": "lineState", - "type": "Attribute (RW)", - "default_value": "tsplink.STATE_HIGH\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or writes the digital state of a TSP-Link synchronization line.", - "details": "Use tsplink.writeport() to write to all TSP-Link synchronization lines.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "lineState", - "description": "The state of the synchronization line", - "enum": "tsplink.STATE_LOW nil|tsplink.STATE_HIGH nil", - "type": "tsplinklinestatelineState", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "lineState = tsplink.line[N].state", - "tsplink.line[N].state = lineState" - ], - "overloads": [], - "examples": [ - { - "example": "lineState = tsplink.line[3].state;print(lineState);", - "description": "Assume line 3 is set high, and then the state is read.\n--- --Output:\n--- --tsplink.STATE_HIGH\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode", - "tsplink.writeport()" - ] - }, - { - "name": "trigger.tsplinkout[N].assert()", - "webhelpfile": "32549.htm", - "signature": "trigger.tsplinkout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding trigger event.", - "details": "Initiates a trigger event and does not wait for completion. The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].clear()", - "webhelpfile": "32551.htm", - "signature": "trigger.tsplinkin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. When this command is sent, the instrument:", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[2].clear();", - "description": "Clears the trigger event on TSP-Link line 2.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].overrun", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].overrun", - "webhelpfile": "32552.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = trigger.tsplinkin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkin[1].overrun);", - "description": "If an event on line 1 was ignored, displays true; if no additional event occurred, displays false.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.tsplinkout[N].pulsewidth", - "webhelpfile": "32553.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to 0 asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0.0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0.0 to 100 ks)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "trigger.tsplinkout[N].release()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].release()", - "webhelpfile": "32555.htm", - "signature": "trigger.tsplinkout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP-Link trigger line.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].stimulus", - "webhelpfile": "32558.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to trigger.EVENT_NONE.Do not use this attribute when triggering under script control. Use trigger.tsplinkout[N].assert() instead.The event parameters that you can use are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event identifier for the triggering event (see Details)", - "enum": "", - "type": "triggerEvents", - "range": "(see Details)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "event = trigger.tsplinkout[N].stimulus", - "trigger.tsplinkout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkout[3].stimulus);", - "description": "Outputs the event that will start action on TSP-Link trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkin[N].wait()", - "webhelpfile": "32561.htm", - "signature": "trigger.tsplinkin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events are detected since the last time this command or trigger.tsplinkin[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.tsplinkin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;triggered = trigger.tsplinkin[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on TSP-Link line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].clear()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "32565.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node.", - "details": "This attribute returns the node number of the master in a set of instruments connected using TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "localnode.version", - "webhelpfile": "32595.htm", - "signature": "", - "command_return": "version", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware version of the instrument.", - "details": "This attribute indicates the version number of the firmware that is presently running in the instrument.", - "param_info": [ - { - "name": "version", - "description": "Instrument version level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "version = localnode.version" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.version);", - "description": "Outputs the present version level. Example output:\n--- --1.0.0a\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "32597.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the instrument's serial number.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT2, \"Serial #: \" ..localnode.serialno);display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clears the instrument display.\n--- --Places the serial number of this instrument on the bottom line of the USER swipe screen display. Displays the USER swipe screen.\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.version" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "32628.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "The instrument automatically detects the power line frequency when the instrument is powered on. Power line frequency can be 50\u00a0Hz or 60\u00a0Hz.", - "param_info": [ - { - "name": "frequency", - "description": "The detected line frequency", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;print(frequency);", - "description": "Reads the line frequency setting.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "32684.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.runscript(myConnection, \"myTest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled myTest on the TSP-enabled instrument connected with myConnection.\n" - } - ], - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "smu.measure.configlist.size()", - "webhelpfile": "32926.htm", - "signature": "smu.measure.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the size (number of configuration indexes) of a measure configuration list.", - "details": "", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total count of indexes stored in the specified measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.measure.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.size(\"testMeasList\"));", - "description": "Returns the number of configuration indexes in a measure configuration list named testMeasList.\n--- --Example output:\n--- --1\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "localnode.access", - "webhelpfile": "33140.htm", - "signature": "", - "command_return": "accessType", - "type": "Attribute (RW)", - "default_value": "localnode.ACCESS_FULL\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the type of access users have to the instrument through different interfaces.", - "details": "When access is set to full, the instrument accepts commands from any interface with no login or password.When access is set to exclusive, you must log out of one remote interface and log into another one to change interfaces. You do not need a password with this access.Protected access is similar to exclusive access, except that you must enter a password when logging\u00a0in.When the access is set to locked out, a password is required to change interfaces, including the front-panel interface.Under any access type, if a script is running on one remote interface when a command comes in from another remote interface, the command is ignored and the message \"FAILURE: A script is running, use ABORT to stop it\" is generated.", - "param_info": [ - { - "name": "accessType", - "description": "The type of access", - "enum": "localnode.ACCESS_FULL nil|localnode.ACCESS_EXCLUSIVE nil|localnode.ACCESS_PROTECTED nil|localnode.ACCESS_LOCKOUT nil", - "type": "localnodeaccessaccessType", - "range": "" - } - ], - "usage": [ - "accessType = localnode.access", - "localnode.access = accessType" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.access = localnode.ACCESS_LOCKOUT;login admin;logout;", - "description": "Set the instrument access to locked out.\n--- --Log into the interface using the default password.\n--- --Log out of the interface.\n" - } - ], - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "smu.source.autodelay", - "webhelpfile": "33143.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the automatic delay that occurs when the source is turned on.", - "details": "When autodelay is turned on, the actual delay that is set depends on the range.When source autodelay is on, if you set a source delay, the autodelay is turned off.", - "param_info": [ - { - "name": "state", - "description": "Disable the source auto delay", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaystate", - "range": "" - }, - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaysourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautodelayfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.autodelay", - "smu.source.autodelay = state", - "state = smu.source.getattribute(function, ATTR_SRC_DELAY_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_DELAY_AUTO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.autodelay = smu.OFF;", - "description": "Turn off auto delay when current is being sourced.\n" - } - ], - "related_commands": [ - "smu.source.delay" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "33148.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.DISABLE\n", - "tsp_link": "No\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Do not generate prompts", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = localnode.ENABLE;", - "description": "Enable prompting.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "smu.source.configlist.recall()", - "webhelpfile": "33155.htm", - "signature": "smu.source.configlist.recall(listName, index, measureListName, measureIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a specific configuration index in a specific source configuration list and an optional measure configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a specific source configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified source configuration list of that index.You can optionally specify a measure configuration list and index to recall with the source settings. If you do not specify a measure index, the measure index defaults to match the source index. Specify a source and measure list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need have the application of the source and measure configuration lists coordinated, you can specify just the source configuration list with this command and use the smu.measure.configlist.recall() command to recall measure settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, event code 2790, \"Configuration list, error, does not exist\" is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. To see the settings that are recalled with an index, use the smu.source.configlist.query() command.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "measureListName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "measureIndex", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)", - "smu.source.configlist.recall(listName, index, measureListName, measureIndex)" - ], - "overloads": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)" - ], - "examples": [ - { - "example": "smu.source.configlist.recall(\"MySourceList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "trigger.lanout[N].logic", - "webhelpfile": "33157.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line.", - "details": "", - "param_info": [ - { - "name": "logicType", - "description": "The type of logic", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerlanoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "logicType = trigger.lanout[N].logic", - "trigger.lanout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[2].logic = trigger.LOGIC_POSITIVE;", - "description": "Set the logic for LAN trigger line 2 to positive.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digout[N].logic", - "webhelpfile": "33159.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the output logic of the trigger event generator to positive or negative for the specified line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerdigoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "logicType = trigger.digout[N].logic", - "trigger.digout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].logic = trigger.LOGIC_NEGATIVE;", - "description": "Sets line 4 mode to be a trigger output and sets the output logic of the trigger event generator to negative (asserts a low pulse).\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "33164.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This command is not available if the buffer style is set to compact.This read-only attribute is an array of status values for the readings in the buffer. The status values are floating-point numbers that encode the status value. Refer to the following table for values.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired; refer to Details", - "enum": "", - "type": "bufferVarstatuses", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.statuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --64, 64\n--- --Indicating that the status is buffer.STAT_LIMIT1_LOW.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.delete()", - "bufferVar.clear()", - "bufferVar.sourcestatuses", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.save()", - "webhelpfile": "33210.htm", - "signature": "buffer.save(bufferVar, fileName, what, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves data from the specified reading buffer to a USB flash drive.", - "details": "The file name must specify the full path (including /usb1/). If included, the file extension must be set to .csv. If no file extension is specified, .csv is added.Examples of valid destination file names:The Model 2461 does not check for existing files when you save. Verify that you are using a unique name to avoid overwriting any existing CSV files on the flash drive.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "what", - "description": "Defines which information is saved in the file on the USB flash drive", - "enum": "", - "type": "bufferFileSaveDetails", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, what)", - "buffer.save(bufferVar, fileName, what, start, end)" - ], - "overloads": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, what)" - ], - "examples": [ - { - "example": "buffer.save(MyBuffer, \"/usb1/myData.csv\");", - "description": "Save all reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Save all readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(defbuffer1, \"/usb1/defbuf1data\", buffer.SAVE_RAW_TIME);", - "description": "Save readings and raw time stamps from defbuffer1 to a file named defbuf1data on the USB flash drive.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.saveappend()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "33260.htm", - "signature": "display.prompt(buttonID, promptText)", - "command_return": "promptID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an interactive dialog prompt that displays a custom message on the front-panel display.", - "details": "This command displays buttons and text on the front panel. You can set up scripts that respond to the buttons when they are selected.If you send display.BUTTONS_NONE, the operator needs to press the EXIT key to clear the message from the front-panel display. You can also use the display.delete() command to remove the prompt.Only one prompt can be active at a time.When the user presses a button, the button presses are returned as one of the following options:To capture return values, you need to use display.waitevent() to wait for the user button selection.", - "param_info": [ - { - "name": "promptID", - "description": "A set of characters that identifies the prompt; up to 63 characters", - "enum": "", - "type": "promptID", - "range": "" - }, - { - "name": "buttonID", - "description": "The type of prompt to display; choose one of the following options", - "enum": "display.BUTTONS_NONE nil|display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displaypromptbuttonID", - "range": "" - }, - { - "name": "promptText", - "description": "A string that contains the text that is displayed above the prompts", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "promptID = display.prompt(buttonID, promptText)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.delete()", - "display.waitevent()" - ] - }, - { - "name": "display.waitevent()", - "webhelpfile": "33261.htm", - "signature": "display.waitevent(timeout)", - "command_return": "objectID, subID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to wait for a user to respond to a prompt that was created with a prompt command.", - "details": "This command waits until a user responds to a front-panel prompt that was created with the display.prompt() command.", - "param_info": [ - { - "name": "objectID", - "description": "A number that identifies the object, such as a prompt message, that is displayed on the front panel", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "subID", - "description": "The returned value after a button is pressed on the front panel", - "enum": "display.BUTTON_YES nil|display.BUTTON_NO nil|display.BUTTON_OK nil|display.BUTTON_CANCEL nil", - "type": "displaywaiteventsubID", - "range": "" - }, - { - "name": "timeout", - "description": "The amount of time to wait before timing out; time is 0 to 300 s, where the default of 0 waits indefinitely", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "objectID, subID = display.waitevent()", - "objectID, subID = display.waitevent(timeout)" - ], - "overloads": [ - "objectID, subID = display.waitevent()" - ], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start, and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.input.prompt()", - "display.prompt()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "33286.htm", - "signature": "script.load(file)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The name that is used for scriptVar must not already exist as a global variable. In addition, the scriptVar name must be a global reference and not a local variable, table, or array.For external scripts, the root folder of the USB flash drive has the absolute path /usb1/.", - "param_info": [ - { - "name": "file", - "description": "A string that contains the path and file name of the script file to load; if scriptVar is not defined, this name is used as the global variable name for this script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The created script; a global variable with this name is used to reference the script", - "enum": "", - "type": "scriptVar", - "range": "" - } - ], - "usage": [ - "script.load(file)", - "scriptVar = script.load(file)" - ], - "overloads": [ - "script.load(file)" - ], - "examples": [ - { - "example": "test8 = script.load(\"/usb1/testSetup.tsp\");", - "description": "Loads the script with the file name testSetup.tsp that is on the USB flash drive and names it test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.catalog()", - "webhelpfile": "33290.htm", - "signature": "for name in script.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script returned from script.catalog()", - "enum": "", - "type": "any", - "range": "()" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the return names from the catalog command", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "for name in script.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n--- --print(name) represent the body parameter shown in the Usage.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "33394.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from the run-time memory and nonvolatile memory.", - "details": "When a script is deleted, the global variable referring to this script is also deleted.You must delete an existing script before you can use the name of that script again. Scripts are not automatically overwritten.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory and the global variable named test8.\n" - } - ], - "related_commands": [ - "Deleting a user script using a remote interface", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "33395.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source code of a script.", - "details": "The body of the script is a single string with lines separated by the new line character.", - "param_info": [ - { - "name": "code", - "description": "The body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source" - ], - "overloads": [], - "examples": [ - { - "example": "print(test7.source);", - "description": "Assuming a script named test7 was created on the instrument, this example retrieves the source code.\n--- --Output:\n--- --reset()\n--- --display.settext(display.TEXT1, \"Text on line 1\")\n--- --display.settext(display.TEXT2, \"Text on line 2\")\n" - } - ], - "related_commands": [ - "scriptVar.save()" - ] - }, - { - "name": "display.lightstate", - "webhelpfile": "33459.htm", - "signature": "", - "command_return": "brightness", - "type": "Attribute (RW)", - "default_value": "display.STATE_LCD_50\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the light output level of the front-panel display.", - "details": "This command changes the light output of the front panel when a test requires different instrument illumination levels.The change in illumination is temporary. The normal backlight settings are restored after a power cycle. You can use this to reset a display that is already dimmed by the front-panel Backlight Dimmer.", - "param_info": [ - { - "name": "brightness", - "description": "The brightness of the display", - "enum": "display.STATE_LCD_100 nil|display.STATE_LCD_75 nil|display.STATE_LCD_50 nil|display.STATE_LCD_25 nil|display.STATE_LCD_OFF nil|display.STATE_BLACKOUT nil", - "type": "displaylightstatebrightness", - "range": "" - } - ], - "usage": [ - "brightness = display.lightstate", - "display.lightstate = brightness" - ], - "overloads": [], - "examples": [ - { - "example": "display.lightstate = display.STATE_LCD_50;", - "description": "Set the display brightness to 50%.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.preset()", - "webhelpfile": "33635.htm", - "signature": "status.preset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears the event registers and the enable registers for operation and questionable. It will not clear the Service Request Enable Register (*SRE) to Standard Request Enable Register (*ESE).Preset does not affect the event queue.The Standard Event Status Register is not affected by this command.", - "param_info": [ - { - "name": "status.preset()", - "description": "Resets the instrument status model.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.preset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.preset();", - "description": "Resets the instrument status model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "buffer.delete()", - "webhelpfile": "33981.htm", - "signature": "buffer.delete(bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a user-defined reading buffer.", - "details": "You cannot delete the default reading buffers, defbuffer1 and defbuffer2.After deleting the buffer, call collectgarbage() to reclaim the memory the buffer was using.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of a user-defined reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "buffer.delete(bufferName)" - ], - "overloads": [], - "examples": [ - { - "example": "buf400\u00a0= buffer.make(400);smu.measure.read(buf400);printbuffer(1, buf400.n, buf400.relativetimestamps);buffer.delete(buf400);collectgarbage();", - "description": "Create a 400-element reading buffer named buf400.\n--- --Make measurements and store the readings in buf400.\n--- --Print the relative timestamps for each reading in the buffer.\n--- --Example output, assuming five readings are stored in the buffer:\n--- --0, 0.412850017, 0.821640085, 1.230558058, 1.629523236\n--- --Delete buf400.\n--- --Use collectgarbage() to unallocate the buffer.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "printbuffer()" - ] - }, - { - "name": "trigger.timer[N].start.seconds", - "webhelpfile": "33984.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.seconds", - "trigger.timer[N].start.seconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.seconds = localnode.gettime() + 30;trigger.timer[1].enable = trigger.ON;", - "description": "Set the trigger timer to start 30 s from the time when the timer is enabled.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].start.fractionalseconds", - "webhelpfile": "33985.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the fractional seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time in fractional seconds (0 to <1 s)", - "enum": "", - "type": "number", - "range": "(0 to <1 s)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.fractionalseconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.fractionalseconds = 0.4;", - "description": "Set the trigger timer to start in 0.4\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].start.generate" - ] - }, - { - "name": "reset()", - "webhelpfile": "34054.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings and clears the buffers.", - "details": "The reset() command in its simplest form resets the entire TSP-enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use the node[N].reset() command. Also use the node[N].reset() command to reset an instrument on a subordinate node.When no value is specified for system, the default value is true.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error event.", - "param_info": [ - { - "name": "system", - "description": "If the node is the master, the entire system is reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error event is generated.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.sourcestatuses", - "webhelpfile": "34340.htm", - "signature": "bufferVar.sourcestatuses[N]", - "command_return": "statusInfo", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source status conditions of the instrument for the reading point.", - "details": "This buffer recall attribute holds an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value for each measurement made. See the following table for values.", - "param_info": [ - { - "name": "statusInfo", - "description": "The status value when reading N of the specified buffer was acquired; Source status values are", - "enum": "buffer.STAT_PROTECTION nil|buffer.STAT_READBACK nil|buffer.STAT_OVER_TEMP nil|buffer.STAT_LIMIT nil|buffer.STAT_SENSE nil|buffer.STAT_OUTPUT nil", - "type": "bufferVarsourcestatusesstatusInfo", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInfo = bufferVar.sourcestatuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.sourcestatuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --136, 136\n--- --Indicating that the status is buffer.STAT_READBACK and buffer.STAT_OUTPUT.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "buffer.delete()", - "print()", - "printbuffer()" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "34363.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP-enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "The termination type", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtermSequence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "34428.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event.Use none to disable the blender input.The event parameter may be any of the trigger events shown in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "triggerEvents[]", - "range": "" - }, - { - "name": "N", - "description": "An integer that represents the trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "buffer.clearstats()", - "webhelpfile": "34560.htm", - "signature": "buffer.clearstats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the statistical information associated with the specified buffer.", - "details": "This command clears the statistics without clearing the readings.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1 if not specified", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "buffer.clearstats()", - "buffer.clearstats(bufferVar)" - ], - "overloads": [ - "buffer.clearstats()" - ], - "examples": [ - { - "example": "buffer.clearstats();", - "description": "Clears statistics for defbuffer1.\n" - } - ], - "related_commands": [ - "buffer.getstats()" - ] - }, - { - "name": "createconfigscript()", - "webhelpfile": "34589.htm", - "signature": "createconfigscript(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a setup file that captures most of the present settings of the instrument.", - "details": "This function does not automatically overwrite existing scripts with the same name. If scriptName is set to the name of an existing script, an event message is returned. You must delete the existing script before using the same script name. This includes the autoexec script, which runs automatically when the instrument power is turned on. You can set scriptName to autoexec, but you must delete the existing autoexec script first using the script.delete(\"autoexec\") command.Once created, the script that contains the settings can be run and edited like any other script.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script that will be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "createconfigscript(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "createconfigscript(\"myConfigurationScript\");reset();myConfigurationScript();", - "description": "Capture the present settings of the instrument into a script named myConfigurationScript.\n--- --Reset the instrument.\n--- --Restore the settings stored in myConfigurationScript.\n" - } - ], - "related_commands": [ - "Saving setups", - "script.delete()" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "34629.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"admin\"\n", - "tsp_link": "No\n", - "description": "This attribute stores the instrument password.", - "details": "When the access to the instrument is set to protected or lockout, this is the password that is used to gain access.If you forget the password, you can reset the password to the default:You can also reset the password and the LAN settings from the rear panel by inserting a straightened paper clip into hole below LAN RESET.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the instrument password (maximum 30 characters)", - "enum": "", - "type": "string", - "range": "(maximum 30 characters)" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the password to N3wpa55w0rd.\n" - } - ], - "related_commands": [ - "localnode.access" - ] - }, - { - "name": "eventlog.post()", - "webhelpfile": "34730.htm", - "signature": "eventlog.post(message, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to post your own text to the event log.", - "details": "You can use this command to create your own event log entries and assign a severity level to them. This can be useful for debugging and status reporting.From the front panel, you must set the Log Warnings and Log Information options on to have the custom warning and information events placed into the event log.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "message", - "description": "String that contains the message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "The type of event; if no event is defined, defaults to eventlog.SEV_INFO", - "enum": "eventlog.SEV_INFO nil|eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil", - "type": "eventlogposteventType", - "range": "" - } - ], - "usage": [ - "eventlog.post(message)", - "eventlog.post(message, eventType)" - ], - "overloads": [ - "eventlog.post(message)" - ], - "examples": [ - { - "example": "eventlog.clear();eventlog.post(\"Results in \\018\", eventlog.SEV_ERROR);print(eventlog.next());", - "description": "Posts an event that states \"Results in \u03a9\".\n--- --Output:\n--- --1005 User: Results in \u03a9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.usbdriveexists()", - "webhelpfile": "34905.htm", - "signature": "file.usbdriveexists()", - "command_return": "driveInserted", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function detects if a USB flash drive is inserted into the front-panel USB port.", - "details": "You can call this command from a script to verify that a USB flash drive is inserted before attempting to write data to it.", - "param_info": [ - { - "name": "driveInserted", - "description": "0", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "driveInserted = file.usbdriveexists()" - ], - "overloads": [], - "examples": [ - { - "example": "local response;local xMax = 10;\u00a0;for x = 1, xMax do; -- Make xMax readings and store them in defbuffer1.; smu.measure.read();end;\u00a0;if (file.usbdriveexists() == 1) then ; response = display.BUTTON_YES;else; response = display.input.prompt(display.BUTTONS_YESNO, \"Insert a USB flash drive.\\nPress Yes to write data or No to not write data.\") ;end;\u00a0;if (response == display.BUTTON_YES) then; if (file.usbdriveexists() == 1) then ; FileNumber = file.open(\"/usb1/TenReadings.csv\", file.MODE_WRITE); file.write(FileNumber,\"Reading,Seconds\\n\");\u00a0; -- Print out the measured values in a two-column format.; print(\"\\nIteration:\\tReading:\\tTime:\\n\");\u00a0; for i = 1, xMax do; print(i, defbuffer1[i], defbuffer1.relativetimestamps[i]); file.write(FileNumber, string.format(\"%g, %g\\r\\n\",defbuffer1.readings[i], defbuffer1.relativetimestamps[i])); end; file.close(FileNumber); else; response = display.input.prompt(display.BUTTONS_OK,; \"No drive detected. Allow more time after inserting a drive.\") ; end;end;", - "description": "Make measurements.\n--- --Verify that a flash drive is inserted into the instrument.\n--- --If the flash drive is inserted, write the data to the flash drive.\n--- --Print data into a two-column format.\n--- --If the flash drive is not inserted after selecting Yes, another prompt is displayed.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.userdelay[N]", - "webhelpfile": "34973.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay in seconds (0 to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 to 10 ks)" - }, - { - "name": "N", - "description": "The number that identifies this user delay (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.source.userdelay[N]", - "smu.source.userdelay[N] = delayTime", - "delayTime = smu.source.getattribute(function, ATTR_SRC_USER_DELAY_N)", - "smu.source.setattribute(function, ATTR_SRC_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_S1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for source 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls source user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "35118.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to two) on which to wait", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n--- --Wait 3 s while checking if trigger blender 1 event has occurred.\n" - } - ], - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.model.load() - ConfigList", - "webhelpfile": "35126.htm", - "signature": "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that uses source and measure configuration lists.", - "details": "This trigger-model template incorporates a source configuration list and measure configuration list. You must set up the configuration lists before loading the trigger model. If the configuration lists change, you must resend this command.You can also set a delay and change the reading buffer.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "ConfigList", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "measureConfigList", - "description": "A string that contains the name of the measurement configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceConfigList", - "description": "A string that contains the name of the source configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"SOURCE_LIST\");smu.measure.configlist.create(\"MEASURE_LIST\");smu.source.level = 1;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 1e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 5;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 10e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 10;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 100e-3;smu.measure.configlist.store(\"MEASURE_LIST\");trigger.model.load(\"ConfigList\", \"MEASURE_LIST\", \"SOURCE_LIST\");trigger.model.initiate();", - "description": "Set up a source configuration list named SOURCE_LIST and a measurement configuration list named MEASURE_LIST. Load the configuration list trigger model, using these two configuration lists. Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - Empty", - "webhelpfile": "35127.htm", - "signature": "trigger.model.load(Empty)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger model.", - "details": "When you load this trigger-model template, any blocks that have been defined in the trigger model are cleared so the trigger model has no blocks defined.", - "param_info": [ - { - "name": "Empty", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "trigger.model.load(\"Empty\")print(trigger.model.getblocklist())", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Clear the trigger model to have no blocks defined.Output:EMPTY", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.load(Empty)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model to have no blocks defined.\n--- --Output:\n--- --EMPTY\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LogicTrigger", - "webhelpfile": "35128.htm", - "signature": "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a logic trigger through the digital I/O.", - "details": "This trigger model waits for a digital input event to occur, makes a measurement, and issues a notify event. The notify event asserts a digital output line.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "LogicTrigger", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "digInLine", - "description": "The digital input line (1 to 6); also, the event that the trigger model will wait on in block\u00a01", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "digOutLine", - "description": "The digital output line (1 to 6)", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLogicTriggerclear", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)" - ], - "examples": [ - { - "example": "trigger.model.load(\"LogicTrigger\", 1, 2, 10, 0.001, defbuffer1);", - "description": "Set up the template to use the digital in line and wait for a pulse from digital in line 1 to trigger measurements.\n--- --Pulse digital out line 2 when the measurement is complete.\n--- --Make 10 measurements, with a delay of 1\u00a0ms before each measurement.\n--- --Store the measurements in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.digout[N].logic" - ] - }, - { - "name": " trigger.BLOCK_LOG_EVENT", - "webhelpfile": "35428.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to log an event in the event log when the trigger model is running.", - "details": "Note that using this block too often in a trigger model could overflow the event log. It may also take away from the time needed to process more critical trigger model blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "eventNumber", - "description": "The event number", - "enum": "trigger.LOG_INFO nil|trigger.LOG_WARN nil|trigger.LOG_ERROR nil|trigger.LOG_WARN_ABORT nil", - "type": "triggermodelsetblocktriggerBLOCK_LOG_EVENTeventNumber", - "range": "" - }, - { - "name": "message", - "description": "A string up to 31 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_LOG_EVENT, trigger.LOG_INFO2, \"Trigger model complete.\");", - "description": "Set trigger model block 9 to log an event when the trigger model completes. In the event log, the message is:\n--- --TM #1 block #9 logged: Trigger model complete.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_NOP", - "webhelpfile": "35431.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a placeholder that performs no action in the trigger model; available only using remote commands.", - "details": "If you remove a trigger model block, you can use this block as a placeholder for the block number so that you do not need to renumber the other blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_NOP);", - "description": "Set block number 4 to be a no operation block.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.delete()", - "webhelpfile": "38977.htm", - "signature": "display.delete(promptID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to remove a prompt on the front-panel display that was created with display.prompt().", - "details": "You can use this command to remove the presently displayed prompt.", - "param_info": [ - { - "name": "promptID", - "description": "The identifier defined by display.prompt()", - "enum": "", - "type": "promptID", - "range": "()" - } - ], - "usage": [ - "display.delete(promptID)" - ], - "overloads": [], - "examples": [ - { - "example": "removePrompt3 = display.prompt(display.BUTTONS_NONE, \"This prompt will disappear in 3 seconds\");delay(3);display.delete(removePrompt3);", - "description": "This example displays a prompt that is automatically removed in three seconds.\n--- --\n" - } - ], - "related_commands": [ - "display.prompt()" - ] - }, - { - "name": "display.input.number()", - "webhelpfile": "40051.htm", - "signature": "display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)", - "command_return": "numberEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that requests a number from the user on the front-panel display.", - "details": "This command prompts the instrument operator to enter a value.The prompt is displayed until it has been responded to.", - "param_info": [ - { - "name": "numberEntered", - "description": "The number that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; can be up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "numberFormat", - "description": "The format of the displayed number", - "enum": "display.NFORMAT_INTEGER nil|display.NFORMAT_DECIMAL nil|display.NFORMAT_EXPONENT nil|display.NFORMAT_PREFIX nil", - "type": "displayinputnumbernumberFormat", - "range": "" - }, - { - "name": "defaultValue", - "description": "The value that is initially displayed in the displayed keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimumValue", - "description": "The lowest value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximumValue", - "description": "The highest value that can be entered", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)" - ], - "overloads": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)" - ], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;testcurrent = display.input.number(\"Enter a Test Current (0 to 1 A)\", display.NFORMAT_PREFIX, 0, 0, 1);smu.source.level = testcurrent;", - "description": "This example displays a number pad on the screen that defaults to 0 and allows entries from 0 to 1. The number that the operator enters is assigned to the source current level. If the operator enters a value outside of the range, an error message is displayed.\n--- --\n" - } - ], - "related_commands": [ - "display.input.option()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.option()", - "webhelpfile": "40052.htm", - "signature": "display.input.option(dialogTitle, buttonTitle1, ...)", - "command_return": "BUTTON_OPTIONn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an option dialog box with customizable buttons on the front-panel display.", - "details": "Buttons are created from top to bottom, left to right. If you have more than five buttons, they are placed into two columns.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "n", - "description": "The number of the button that is selected from the front-panel display; nil if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right", - "enum": "", - "type": "display_BUTTON_OPTIONs | nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "buttonTitle1", - "description": "A string that contains the name of the first button; up to 15 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "A string that contains the names of subsequent buttons, where N is a number from 2 to 10; you can define up to 10 buttons; each button can be up to 15 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "BUTTON_OPTIONn = display.input.option(dialogTitle, buttonTitle1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "optionID = display.input.option(\"Select an option\", \"Apple\", \"Orange\", \"Papaya\", \"Pineapple\", \"Blueberry\", \"Banana\", \"Grapes\", \"Peach\", \"Apricot\", \"Guava\");print(optionID);", - "description": "This example displays the following dialog box:\n--- --\n--- --If the user selects Peach, the return is display.BUTTON_OPTION8.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.prompt()", - "webhelpfile": "40053.htm", - "signature": "display.input.prompt(buttonSet, dialogTitle)", - "command_return": "buttonReturn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that accepts a user response from the front-panel display.", - "details": "This command waits for a user response to the prompt. You can use the text to ask questions that can be used to configure your test.The prompt is displayed until it has been responded to by the user. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "buttonReturn", - "description": "Indicates which button was pressed", - "enum": "display.BUTTON_OK nil|display.BUTTON_CANCEL nil|display.BUTTON_YES nil|display.BUTTON_NO nil", - "type": "displayinputpromptbuttonReturn", - "range": "" - }, - { - "name": "buttonSet", - "description": "The set of buttons to display", - "enum": "display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displayinputpromptbuttonSet", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 63 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buttonReturn = display.input.prompt(buttonSet, dialogTitle)" - ], - "overloads": [], - "examples": [ - { - "example": "result = display.input.prompt(display.BUTTONS_YESNO, \"Do you want to display the graph screen?\");if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "This displays the prompt \"Do you want to display the graph screen?\" on the front-panel display:\n--- --\n--- -- If the operator selects Yes, the graph screen is displayed.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.string()" - ] - }, - { - "name": "display.input.string()", - "webhelpfile": "40054.htm", - "signature": "display.input.string(dialogTitle, textFormat)", - "command_return": "textEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a dialog box that requests text from the user through the front-panel display.", - "details": "This command creates a prompt to the instrument operator to enter a string value.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "textEntered", - "description": "The text that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "textFormat", - "description": "The format of the entered text", - "enum": "display.SFORMAT_ANY nil|display.SFORMAT_UPPER_LOWER nil|display.SFORMAT_UPPER nil|display.SFORMAT_BUFFER_NAME nil", - "type": "displayinputstringtextFormat", - "range": "" - } - ], - "usage": [ - "textEntered = display.input.string(dialogTitle)", - "textEntered = display.input.string(dialogTitle, textFormat)" - ], - "overloads": [ - "textEntered = display.input.string(dialogTitle)" - ], - "examples": [ - { - "example": "value = display.input.string(\"Enter Test Name\", display.SFORMAT_ANY);print(value);", - "description": "This example displays the prompt \"Enter Test Name\" and a keyboard that the operator can use to enter a response.\n--- --\n--- --The return is the response from the operator.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.prompt()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "40235.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.ENABLE\n", - "tsp_link": "No\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = localnode.DISABLE;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "smu.digitize.read()", - "webhelpfile": "41093.htm", - "signature": "smu.digitize.read(bufferName)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes digitize measurements, places them in a reading buffer, and returns the last reading.", - "details": "You must set the instrument to make digitize measurements before sending this command with the smu.digitize.func attribute.This command initiates measurements using the present function settings, stores the readings in a reading buffer, and returns the last reading.This command makes the number of digitize measurements that is set by the smu.digitize.count attribute.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if nothing is specified, the reading is stored in defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading = smu.digitize.read()", - "reading = smu.digitize.read(bufferName)" - ], - "overloads": [ - "reading = smu.digitize.read()" - ], - "examples": [ - { - "example": "voltMeasBuffer = buffer.make(10000);smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;print(smu.digitize.read(voltMeasBuffer));", - "description": "Create a buffer named voltMeasBuffer. Set the instrument to digitize voltage.\n--- --Make a measurement that is stored in the voltMeasBuffer and is also printed.\n" - } - ], - "related_commands": [ - "buffer.make()", - "smu.digitize.count", - "smu.digitize.func", - "smu.digitize.unit", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.digitize.displaydigits", - "webhelpfile": "41150.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.DIGITS_4_5\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the number of digits that are displayed on the front panel for the selected function.", - "details": "This command affects how the reading for a measurement is displayed on the front panel of the instrument. It does not affect the number of digits returned in a remote command reading. It also does not affect the accuracy or speed of measurements.The display digits setting is saved with the function setting, so if you use another function, then return to the function for which you set display digits, the display digits setting you set previously is retained.The change in digits occurs the next time a measurement is made.To change the number of digits returned in a remote command reading, use format.asciiprecision.", - "param_info": [ - { - "name": "value", - "description": "6\u00bd display digits", - "enum": "smu.DIGITS_6_5 nil|smu.DIGITS_5_5 nil|smu.DIGITS_4_5 nil|smu.DIGITS_3_5 nil", - "type": "smudigitizedisplaydigitsvalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizedisplaydigitsfunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.displaydigits", - "smu.digitize.displaydigits = value", - "value = smu.measure.getattribute(function, ATTR_DIGI_DIGITS)", - "smu.measure.setattribute(function, ATTR_DIGI_DIGITS, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.displaydigits = smu.DIGITS_3_5;", - "description": "Set the instrument to use the digitize current measure function.\n--- --Set the front panel to display 3\u00bd digits.\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "smu.digitize.limit[Y].autoclear", - "webhelpfile": "41210.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the test result for limit Y should be cleared automatically or not.", - "details": "When auto clear is set to on, limit conditions are cleared automatically after each measurement. If you are making a series of measurements, the instrument shows the limit test result of the last measurement for the pass or fail indication for the limit.If you want to know if any of a series of measurements failed the limit, set the auto clear setting to off. When this is set to off, a failed indication is not cleared automatically. It remains set until it is cleared with the clear command.The auto clear setting affects both the high and low limits.", - "param_info": [ - { - "name": "state", - "description": "The auto clear setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smudigitizelimitautoclearstate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizelimitautoclearfunction", - "range": "" - } - ], - "usage": [ - "state = smu.digitize.limit[Y].autoclear", - "smu.digitize.limit[Y].autoclear = state", - "state = smu.measure.getattribute(function, ATTR_DIGI_LIMIT_AUTO_CLEAR_Y)", - "smu.measure.setattribute(function, ATTR_DIGI_LIMIT_AUTO_CLEAR_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;smu.digitize.limit[1].autoclear = smu.OFF;", - "description": "Turns off autoclear for limit 1 when measuring digitize voltage.\n" - } - ], - "related_commands": [ - "smu.digitize.limit[Y].enable" - ] - }, - { - "name": "smu.digitize.limit[Y].clear()", - "webhelpfile": "41213.htm", - "signature": "smu.digitize.limit[Y].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This attribute clears the results of the limit test defined by Y.", - "details": "Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared.To avoid the need to manually clear the test results for a limit, turn the auto clear option on.", - "param_info": [ - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.digitize.limit[Y].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;smu.digitize.limit[1].clear();", - "description": "Set the digitize function to voltage.\n--- --Clear the results of limit test 1.\n" - } - ], - "related_commands": [ - "Digitize functions", - "smu.digitize.limit[Y].autoclear", - "smu.digitize.func" - ] - }, - { - "name": "smu.digitize.limit[Y].low.value", - "webhelpfile": "41215.htm", - "signature": "", - "command_return": "lowLimit", - "type": "Attribute (RW)", - "default_value": "-1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the lower limit for limit tests.", - "details": "This command sets the lower limit for the limit Y test for the selected digitize function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.This example enables limits 1 and 2 for digitize voltage measurements. Limit 1 is checking for readings to be between 3\u00a0V and 5\u00a0V, while limit\u00a02 is checking for the readings to be between 1\u00a0V and 7\u00a0V. The auto clear feature is disabled, so if any reading is outside these limits, the corresponding fail is 1. Therefore, if any one of the fails is 1, analyze the reading buffer data to find out which reading failed the limits.", - "param_info": [ - { - "name": "lowLimit", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)", - "enum": "", - "type": "any", - "range": "(-9.99999E+11 to 9.99999E+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizelimitlowvaluefunction", - "range": "" - } - ], - "usage": [ - "lowLimit = smu.digitize.limit[Y].low.value", - "smu.digitize.limit[Y].low.value = lowLimit", - "lowLimit = smu.measure.getattribute(function, ATTR_DIGI_LIMIT_LOW_Y)", - "smu.measure.setattribute(function, ATTR_DIGI_LIMIT_LOW_Y, lowLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();-- Set the instrument to measure digitized voltage ;smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;-- Set the range to 10 V;-- Set the instrument to source current;smu.source.func=smu.FUNC_DC_CURRENT;smu.digitize.range = 10;-- Disable auto clearing for limit 1;smu.digitize.limit[1].autoclear = smu.OFF;-- Set high limit on 1 to fail if reading exceeds 5 V;smu.digitize.limit[1].high.value = 5;-- Set low limit on 1 to fail if reading is less than 3 V;smu.digitize.limit[1].low.value = 3;-- Enable limit 1 checking for digitized voltage measurements;smu.digitize.limit[1].enable = smu.ON;-- Disable auto clearing for limit 2;smu.digitize.limit[2].autoclear = smu.OFF;-- Set high limit on 2 to fail if reading exceeds 7 V;smu.digitize.limit[2].high.value = 7;-- Set low limit on 2 to fail if reading is less than 1 V;smu.digitize.limit[2].low.value = 1;-- Set the beeper to sound if the reading exceeds the limits for limit 2;smu.digitize.limit[2].audible = smu.AUDIBLE_FAIL ;-- Enable limit 2 checking for digitized voltage measurements;smu.digitize.limit[2].enable = smu.ON;-- Set the digitize count to 50;smu.digitize.count = 50;-- Create a reading buffer that can store 100 readings;LimitBuffer = buffer.make(100);-- Make 50 readings and store them in LimitBuffer;smu.digitize.read(LimitBuffer);-- Check if any of the 50 readings were outside of the limits;print(\"limit 1 results = \" .. smu.digitize.limit[1].fail);print(\"limit 2 results = \" .. smu.digitize.limit[2].fail);-- Clear limit 1 conditions;smu.digitize.limit[1].clear();-- Clear limit 2 conditions;smu.digitize.limit[2].clear();", - "description": "Example output that shows all readings are within limit values (all readings between 3 V and 5 V):\n--- --limit 1 results = smu.FAIL_NONE\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 high values (a 6\u00a0V reading would cause this condition or a reading greater than 5 V but less than 7 V):\n--- --limit 1 results = smu.FAIL_HIGH\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 and 2 low values (a 0.5 V reading would cause this condition or a reading less than 1\u00a0V):\n--- --limit 1 results = smu.FAIL_LOW\n--- --limit 2 results = smu.FAIL_LOW\n" - } - ], - "related_commands": [ - "smu.digitize.limit[Y].autoclear", - "smu.digitize.limit[Y].clear()", - "smu.digitize.limit[Y].enable", - "smu.digitize.limit[Y].fail", - "smu.digitize.limit[Y].high.value" - ] - }, - { - "name": "smu.digitize.limit[Y].fail", - "webhelpfile": "41221.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute queries the results of a limit test.", - "details": "This command queries the result of a limit test for the selected digitize function.The response message indicates if the limit test passed or how it failed (on the high or low limit).If autoclear is set to off, reading the results of a limit test does not clear the fail indication of the test. To clear a failure, send the clear command. To automatically clear the results, set auto clear on.If auto clear is set to on and you are making a series of measurements, the last measurement limit determines the fail indication for the limit. If auto clear is turned off, the results return a test fail if any of one of the readings failed.To use this attribute, you must set the limit state to on.If the readings are stored in a reading buffer, you can use the bufferVar.statuses command to see the results.See smu.digitize.limit[Y].low.value for examples of how to use this command.", - "param_info": [ - { - "name": "value", - "description": "The results of the limit test for limit Y", - "enum": "smu.FAIL_NONE nil|smu.FAIL_HIGH nil|smu.FAIL_LOW nil|smu.FAIL_BOTH nil", - "type": "smudigitizelimitfailvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizelimitfailfunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.limit[Y].fail", - "value = smu.measure.getattribute(function, ATTR_DIGI_LIMIT_FAIL_Y)" - ], - "overloads": [], - "examples": [ - { - "example": "value;", - "description": "The results of the limit test for limit Y:\n--- --smu.FAIL_NONE: Test passed; measurement under or equal to the high limitsmu.FAIL_HIGH: Test failed; measurement exceeded high limitsmu.FAIL_LOW: Test failed; measurement exceeded low limitsmu.FAIL_BOTH: Test failed; measurement exceeded both " - } - ], - "related_commands": [ - "smu.digitize.limit[Y].enable" - ] - }, - { - "name": "smu.digitize.limit[Y].enable", - "webhelpfile": "41225.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables a limit test on the measurement from the selected digitize function.", - "details": "This command enables or disables a limit test for the selected digitize function. When this attribute is enabled, the limit Y testing occurs on each measurement made by the instrument. Limit Y testing compares the measurements to the high and low limit values. If a measurement falls outside these limits, the test fails.See smu.digitize.limit[Y].low.value for examples of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "Limit Y testing", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smudigitizelimitenablestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizelimitenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.digitize.limit[Y].enable", - "smu.digitize.limit[Y].enable = state", - "state = smu.measure.getattribute(function, ATTR_DIGI_LIMIT_ENABLE_Y)", - "smu.measure.setattribute(function, ATTR_DIGI_LIMIT_ENABLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "state;", - "description": "Limit Y testing:\n--- --Disable: smu.OFFEnable: " - } - ], - "related_commands": [ - "smu.digitize.limit[Y].low.value", - "smu.digitize.limit[Y].high.value" - ] - }, - { - "name": "smu.digitize.limit[Y].high.value", - "webhelpfile": "41227.htm", - "signature": "", - "command_return": "highLimit", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the upper limit for a limit test.", - "details": "This command sets the high limit for the limit Y test for the selected digitize function. When limit Y testing is enabled, the instrument generates a fail indication when the measurement value is more than this value.See smu.digitize.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "highLimit", - "description": "The value of the upper limit (-9.99999e+11 to +9.99999e+11)", - "enum": "", - "type": "any", - "range": "(-9.99999e+11 to +9.99999e+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizelimithighvaluefunction", - "range": "" - } - ], - "usage": [ - "highLimit = smu.digitize.limit[Y].high.value", - "smu.digitize.limit[Y].high.value = highLimit", - "highLimit = smu.measure.getattribute(function, ATTR_DIGI_LIMIT_HIGH_Y)", - "smu.measure.setattribute(function, ATTR_DIGI_LIMIT_HIGH_Y, highLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "highLimit;", - "description": "The value of the upper limit (-9.99999e+11 to +9.99999e+11)\n" - } - ], - "related_commands": [ - "smu.digitize.limit[Y].enable", - "smu.digitize.limit[Y].low.value" - ] - }, - { - "name": "smu.digitize.rel.acquire()", - "webhelpfile": "41236.htm", - "signature": "smu.digitize.rel.acquire()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function acquires a measurement and stores it as the relative offset value for the selected digitize function.", - "details": "This command triggers the instrument to make a new measurement for the selected function. This measurement is then stored as the new relative offset level.When you send this command, the instrument does not apply any math, limit test, or filter settings to the measurement, even if they are set. It is a measurement that is made as if these settings are disabled.If an error event occurs during the measurement, nil is returned and the relative offset level remains at the last valid setting.You must change to the function for which you want to acquire a value before sending this command.The instrument must have relative offset enabled to use the acquired relative offset value.After executing this command, you can use the smu.digitize.rel.level attribute to see the last relative level value that was acquired or that was set.", - "param_info": [ - { - "name": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENTrel_value = smu.digitize.rel.acquire()smu.digitize.rel.enable = smu.ONprint(rel_value)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Acquires a relative offset level value for the digitize current function and turns the relative offset feature on.Output the value of the offset.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.digitize.rel.acquire()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;rel_value = smu.digitize.rel.acquire();smu.digitize.rel.enable = smu.ON;print(rel_value);", - "description": "Acquires a relative offset level value for the digitize current function and turns the relative offset feature on.\n--- --Output the value of the offset.\n" - } - ], - "related_commands": [ - "smu.digitize.func", - "smu.digitize.rel.enable", - "smu.digitize.rel.level" - ] - }, - { - "name": "smu.digitize.math.enable", - "webhelpfile": "41240.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables math operations on measurements for the selected digitize function.", - "details": "When this command is set to on, the math operation specified by the math format command is performed before completing a measurement.", - "param_info": [ - { - "name": "value", - "description": "The math enable setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smudigitizemathenablevalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizemathenablefunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.math.enable", - "smu.digitize.math.enable = value", - "value = smu.measure.getattribute(function, ATTR_DIGI_MATH_ENABLE)", - "smu.measure.setattribute(function, ATTR_DIGI_MATH_ENABLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;smu.digitize.math.format = smu.MATH_PERCENT;smu.digitize.count = 1;smu.digitize.math.percent = smu.digitize.read();smu.digitize.math.enable = smu.ON;smu.digitize.count = 5;MathBuffer = buffer.make(100);smu.digitize.read(MathBuffer);printbuffer(1, MathBuffer.n, MathBuffer.formattedreadings);smu.digitize.count = 1;for x = 1, 3 do ; print(smu.digitize.read(MathBuffer));end;", - "description": "Configure the instrument for digitize voltage.\n--- --Set math format to percent. \n--- --Acquire 1 reading to use as the relative percent value.\n--- --Take 5 readings with percent math enabled and store them in a buffer called MathBuffer that can store 100 readings.\n--- --\u00a0\n--- --Take three additional readings.\n--- --\u00a0\n--- --Sample output assuming no load was connected to the instrument:\n--- ---100.00 %, -100.00 %, -100.00 %, -100.00 %, -100.00 %\n--- ---100.00058257\n--- ---99.999126228\n--- ---99.998932056\n" - } - ], - "related_commands": [ - "smu.digitize.math.format" - ] - }, - { - "name": "smu.digitize.math.format", - "webhelpfile": "41243.htm", - "signature": "", - "command_return": "operation", - "type": "Attribute (RW)", - "default_value": "smu.MATH_PERCENT\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which math operation is performed on measurements when math operations are enabled.", - "details": "This specifies which math operation is performed on measurements for the selected digitize function.You can choose one of the following math operations:Math calculations are applied to the input signal after relative offset and before limit tests.", - "param_info": [ - { - "name": "operation", - "description": "Math operation to be performed on measurements", - "enum": "smu.MATH_MXB nil|smu.MATH_PERCENT nil|smu.MATH_RECIPROCAL nil", - "type": "smudigitizemathformatoperation", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizemathformatfunction", - "range": "" - } - ], - "usage": [ - "operation = smu.digitize.math.format", - "smu.digitize.math.format = operation", - "operation = smu.measure.getattribute(function, ATTR_DIGI_MATH_FORMAT)", - "smu.measure.setattribute(function, ATTR_DIGI_MATH_FORMAT, operation)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;smu.digitize.math.format = smu.MATH_RECIPROCAL;smu.digitize.math.enable = smu.ON;", - "description": "Enables the reciprocal math operation on digitize voltage measurements.\n" - } - ], - "related_commands": [ - "smu.digitize.math.enable" - ] - }, - { - "name": "smu.digitize.math.mxb.bfactor", - "webhelpfile": "41252.htm", - "signature": "", - "command_return": "offsetFactor", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the offset, b, for the y = mx + b operation.", - "details": "This attribute specifies the offset (b) for an mx + b operation.The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation:Where:", - "param_info": [ - { - "name": "offsetFactor", - "description": "The offset for the y = mx + b operation; the valid range is -1e12 to +>1e12", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizemathmxbbfactorfunction", - "range": "" - } - ], - "usage": [ - "offsetFactor = smu.digitize.math.mxb.bfactor", - "smu.digitize.math.mxb.bfactor = offsetFactor", - "offsetFactor = smu.measure.getattribute(function, ATTR_DIGI_MATH_MXB_BF)", - "smu.measure.setattribute(function, ATTR_DIGI_MATH_MXB_BF, offsetFactor)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.math.format = smu.MATH_MXB;smu.digitize.math.mxb.mfactor = 0.80;smu.digitize.math.mxb.bfactor = 42;smu.digitize.math.enable = smu.ON;", - "description": "Set the digitize function to digitize current.\n--- --Set the scale factor for the mx +b operation to 0.80.\n--- --Set the offset factor to 42.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.digitize.math.enable", - "smu.digitize.math.format", - "smu.digitize.math.mxb.mfactor" - ] - }, - { - "name": "smu.digitize.math.mxb.mfactor", - "webhelpfile": "41255.htm", - "signature": "", - "command_return": "scaleFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the scale factor, m, for the y = mx + b math operation.", - "details": "This command sets the scale factor (m) for an mx + b operation for the selected measurement function.The mx + b math operation lets you manipulate normal display readings (x) mathematically according to the following calculation:Where: ", - "param_info": [ - { - "name": "scaleFactor", - "description": "The scale factor; the valid range is -1e12 to +>1e12", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizemathmxbmfactorfunction", - "range": "" - } - ], - "usage": [ - "scaleFactor = smu.digitize.math.mxb.mfactor", - "smu.digitize.math.mxb.mfactor = scaleFactor", - "scaleFactor = smu.measure.getattribute(function, ATTR_DIGI_MATH_MXB_MF)", - "smu.measure.setattribute(function, ATTR_DIGI_MATH_MXB_MF, scaleFactor)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.math.format = smu.MATH_MXB;smu.digitize.math.mxb.mfactor = 0.80;smu.digitize.math.mxb.bfactor = 42;smu.digitize.math.enable = smu.ON;", - "description": "Set the digitize function to digitize current.\n--- --Set the scale factor for the mx +b operation to 0.80.\n--- --Set the offset factor to 42.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.digitize.math.enable", - "smu.digitize.math.format", - "smu.digitize.math.mxb.bfactor" - ] - }, - { - "name": "smu.digitize.math.percent", - "webhelpfile": "41257.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the reference constant that is used when math operations are set to percent.", - "details": "The percent math function displays measurements as percent deviation from a specified reference constant. The percent calculation is:Where:", - "param_info": [ - { - "name": "value", - "description": "The reference used when the math operation is set to percent; the range is -1e12 to +1e12", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizemathpercentfunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.math.percent", - "smu.digitize.math.percent = value", - "value = smu.measure.getattribute(function, ATTR_DIGI_MATH_PERCENT)", - "smu.measure.setattribute(function, ATTR_DIGI_MATH_PERCENT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.math.format = smu.MATH_PERCENT;smu.digitize.math.percent = 42;smu.digitize.math.enable = smu.ON;", - "description": "Set the measurement function to digitize current.\n--- --Set the math operations to percent.\n--- --Set the percentage value to 42.\n--- --Enable math operations.\n" - } - ], - "related_commands": [ - "smu.digitize.math.enable", - "smu.digitize.math.format" - ] - }, - { - "name": "smu.digitize.userdelay[N]", - "webhelpfile": "41269.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay (0 for no delay, or 167\u00a0ns to 10 ks)", - "enum": "", - "type": "any", - "range": "(0 for no delay, or 167\u00a0ns to 10 ks)" - }, - { - "name": "N", - "description": "The user delay to which this time applies (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizeuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.digitize.userdelay[N]", - "smu.digitize.userdelay[N] = delayTime", - "delayTime = smu.measure.getattribute(function, ATTR_DIGI_USER_DELAY_N)", - "smu.measure.setattribute(function, ATTR_DIGI_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.userdelay[2] = 0.5;trigger.model.setblock(6, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M2);", - "description": "Set user delay 2 to be 0.5 s. Sets trigger-model block 6 to use the delay.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "smu.digitize.rel.level", - "webhelpfile": "41275.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the relative offset value.", - "details": "This command specifies the relative offset value that can be applied to new digitized measurements. When relative offset is enabled, all subsequent digitized readings are offset by the value that is set for this command.You can set this value, or have the instrument acquire a value. If the instrument acquires the value, read this setting to return the value that was measured internally.", - "param_info": [ - { - "name": "value", - "description": "Relative offset value for digitized measurements", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizerellevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.rel.level", - "smu.digitize.rel.level = value", - "value = smu.measure.getattribute(function, ATTR_DIGI_REL_LEVEL)", - "smu.measure.setattribute(function, ATTR_DIGI_REL_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.rel.level = smu.digitize.read();smu.digitize.rel.enable = smu.ON;", - "description": "Set the digitize function to digitize current.\n--- --Set the relative offset level to be the reading with any calculations included.\n--- --Enable the relative offset.\n" - } - ], - "related_commands": [ - "smu.digitize.rel.acquire()", - "smu.digitize.rel.enable" - ] - }, - { - "name": "smu.digitize.rel.enable", - "webhelpfile": "41280.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the application of a relative offset value to the measurement.", - "details": "When relative measurements are enabled, all subsequent digitized readings are offset by the relative offset value that was calculated when you acquired the relative offset value.Each returned measured relative reading is the result of the following calculation:", - "param_info": [ - { - "name": "state", - "description": "The setting", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smudigitizerelenablestate", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizerelenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.digitize.rel.enable", - "smu.digitize.rel.enable = state", - "state = smu.measure.getattribute(function, ATTR_DIGI_REL_ENABLE)", - "smu.measure.setattribute(function, ATTR_DIGI_REL_ENABLE, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.rel.acquire();smu.digitize.rel.enable = smu.ON;", - "description": "Enables the relative measurements for digitize current after using the acquire command to set the relative level.\n" - } - ], - "related_commands": [ - "smu.digitize.rel.acquire()", - "smu.digitize.rel.level" - ] - }, - { - "name": "smu.digitize.count", - "webhelpfile": "41297.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "10,000\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements to digitize when a measurement is requested.", - "details": "The digitize function makes the number of readings set by this command in the time set by the sample rate. This command does not affect the trigger model.", - "param_info": [ - { - "name": "count", - "description": "The number of measurements to make (1 to 55,000,000 or buffer capacity)", - "enum": "", - "type": "any", - "range": "(1 to 55,000,000 or buffer capacity)" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizecountfunction", - "range": "" - } - ], - "usage": [ - "count = smu.digitize.count", - "smu.digitize.count = count", - "count = smu.measure.getattribute(function, ATTR_DIGI_COUNT)", - "smu.measure.setattribute(function, ATTR_DIGI_COUNT, count)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.aperture = smu.APERTURE_AUTO;smu.digitize.samplerate = 1000000;smu.digitize.count = 10;print(smu.digitize.read());", - "description": "Set the digitize function to measure current. Set the sample rate to 1,000,000, with a count of 10, and automatic aperture.\n--- --Make a digitize measurement.\n--- --Example output:\n--- ---0.0039799990218\n" - } - ], - "related_commands": [ - "Digitize functions", - "smu.digitize.aperture", - "smu.digitize.samplerate" - ] - }, - { - "name": "smu.digitize.range", - "webhelpfile": "41306.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Current: 100 mAVoltage: 7 V\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale measure range for the selected digitize function.", - "details": "When you assign a range value, the instrument selects a fixed range that is large enough to measure the assigned value. The instrument selects the best range for measuring the maximum expected value.For example, for digitize current measurements, if you expect a reading of approximately 9\u00a0mA, set the range to 9 mA to select the 10\u00a0mA range.When you read this setting, you see the positive full-scale value of the measurement range that the instrument is presently using.", - "param_info": [ - { - "name": "value", - "description": "Set to the maximum expected value to be measured", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizerangefunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.range", - "smu.digitize.range = value", - "value = smu.measure.getattribute(function, ATTR_DIGI_RANGE)", - "smu.measure.setattribute(function, ATTR_DIGI_RANGE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;smu.digitize.range = 90;", - "description": "Set the function to digitize voltage. Set the range to 90\u00a0V, which selects the 100\u00a0V range.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.digitize.func", - "webhelpfile": "41428.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines which digitize function is active.", - "details": "Set this command to the type of measurement you want to digitize.Reading this command returns the digitize function that is presently active.If a basic (non-digitize) measurement function is selected, this returns smu.FUNC_NONE. The none setting is automatically made if you select a function with smu.measure.func or through the options from the front-panel Measure Functions tab.", - "param_info": [ - { - "name": "value", - "description": "The digitize measurement function to make active", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil|smu.FUNC_NONE nil", - "type": "smudigitizefuncvalue", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.func", - "smu.digitize.func = value" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;", - "description": "Set the measurement function to digitize current.\n" - } - ], - "related_commands": [ - "Digitize functions", - "smu.measure.func" - ] - }, - { - "name": "smu.digitize.aperture", - "webhelpfile": "41431.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "smu.APERTURE_AUTO\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the aperture setting for the selected function.", - "details": "The aperture is the actual acquisition time of the instrument on the signal. The aperture can be set to automatic or to a specific value in 1\u00a0\u03bcs intervals. If the value is not specified in microseconds, the value is rounded down to the nearest microsecond resolution. When automatic is selected, the aperture setting is set to the maximum value possible for the selected sample rate.The aperture must be less than the reciprocal of the sample rate. The minimum aperture is 1\u00a0\u03bcs when the maximum sampling rate is 1,000,000 samples per second.Set the sample rate before changing the aperture.The maximum aperture available is 1 divided by the sample rate. The aperture cannot be set to more than this value.", - "param_info": [ - { - "name": "time", - "description": "The time of the aperture in seconds or automatic", - "enum": "smu.APERTURE_AUTO nil", - "type": "smudigitizeaperturetime", - "range": "" - } - ], - "usage": [ - "time = smu.digitize.aperture", - "smu.digitize.aperture = time", - "time = smu.measure.getattribute(function, ATTR_DIGI_APERTURE)", - "smu.measure.setattribute(function, ATTR_DIGI_APERTURE, time)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.samplerate = 200000;smu.digitize.aperture = smu.APERTURE_AUTO;smu.digitize.count = 1;print(smu.digitize.read());", - "description": "Set the digitize function to measure current. Set the sample rate to 200,000, with a count of 1, and automatic aperture.\n--- --Make a digitize measurement.\n" - } - ], - "related_commands": [ - "Digitize functions", - "smu.digitize.func", - "smu.digitize.samplerate" - ] - }, - { - "name": "smu.digitize.samplerate", - "webhelpfile": "41433.htm", - "signature": "", - "command_return": "readings", - "type": "Attribute (RW)", - "default_value": "100,000 \n", - "tsp_link": "Yes\n", - "description": "This attribute defines the precise acquisition rate at which the digitizing measurements are made.", - "details": "The sample rate determines how fast the Model 2461 acquires a digitized reading.Set the sample rate before setting the aperture. If the aperture setting is too high for the selected sample rate, it is automatically adjusted to the highest aperture that can be used with the sample rate.", - "param_info": [ - { - "name": "readings", - "description": "The number of readings per second", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizesampleratefunction", - "range": "" - } - ], - "usage": [ - "readings = smu.digitize.samplerate", - "smu.digitize.samplerate = readings", - "readings = smu.measure.getattribute(function, ATTR_DIGI_SAMPLE_RATE)", - "smu.measure.setattribute(function, ATTR_DIGI_SAMPLE_RATE, readings)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_CURRENT;smu.digitize.samplerate = 200000;smu.digitize.aperture = smu.APERTURE_AUTO;smu.digitize.count = 1;print(smu.digitize.read());", - "description": "Set the digitize function to digitize current. Set the sample rate to 200,000, with a count of 1, and automatic aperture.\n--- --Make a digitize measurement.\n" - } - ], - "related_commands": [ - "smu.digitize.aperture", - "smu.digitize.count" - ] - }, - { - "name": "smu.digitize.readwithtime()", - "webhelpfile": "41622.htm", - "signature": "smu.digitize.readwithtime(bufferName)", - "command_return": "reading, seconds, fractional", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates digitize measurements and returns the last actual measurement and time information in UTC format without using the trigger mode.", - "details": "This command initiates digitize measurements using the present function settings, stores the readings in a reading buffer, and returns the last reading.The smu.digitize.count attribute determines how many measurements are performed.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "seconds", - "description": "Seconds in UTC format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractional", - "description": "Fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading, seconds, fractional = smu.digitize.readwithtime()", - "reading, seconds, fractional = smu.digitize.readwithtime(bufferName)" - ], - "overloads": [ - "reading, seconds, fractional = smu.digitize.readwithtime()" - ], - "examples": [ - { - "example": "print(smu.digitize.readwithtime(defbuffer1));", - "description": "Print the last digitize measurement and time information from defbuffer1 in UTC format, which will look similar to:\n--- ---0.0003882925875\t1415795836\t0.946164546\n" - } - ], - "related_commands": [ - "smu.digitize.count", - "smu.digitize.func", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.measure.limit[Y].audible", - "webhelpfile": "41684.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.AUDIBLE_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument beeper sounds when a limit test passes or fails.", - "details": "The tone and length of beeper cannot be adjusted.See smu.measure.limit[Y].fail for an example of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "When the beeper sounds", - "enum": "smu.AUDIBLE_NONE nil|smu.AUDIBLE_FAIL nil|smu.AUDIBLE_PASS nil", - "type": "smumeasurelimitaudiblestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitaudiblefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].audible", - "smu.measure.limit[Y].audible = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "state;", - "description": "When the beeper sounds:\n--- --Never: smu.AUDIBLE_NONEOn test failure: smu.AUDIBLE_FAILOn test pass: smu.AUDIBL" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.digitize.limit[Y].audible", - "webhelpfile": "41685.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.AUDIBLE_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument beeper sounds when a limit test passes or fails.", - "details": "The tone and length of beeper cannot be adjusted.See smu.digitize.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "value", - "description": "When the beeper sounds", - "enum": "smu.AUDIBLE_NONE nil|smu.AUDIBLE_FAIL nil|smu.AUDIBLE_PASS nil", - "type": "smudigitizelimitaudiblevalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizelimitaudiblefunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.limit[Y].audible", - "smu.digitize.limit[Y].audible = value", - "value = smu.measure.getattribute(function, ATTR_DIGI_LIMIT_AUDIBLE_Y)", - "smu.measure.setattribute(function, ATTR_DIGI_LIMIT_AUDIBLE_Y, value)" - ], - "overloads": [], - "examples": [ - { - "example": "value;", - "description": "When the beeper sounds:\n--- --Never: smu.AUDIBLE_NONEOn test failure: smu.AUDIBLE_FAILOn test pass: smu.AUDIBL" - } - ], - "related_commands": [ - "smu.digitize.limit[Y].enable" - ] - }, - { - "name": " trigger.BLOCK_RESET_BRANCH_COUNT", - "webhelpfile": "41689.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a block in the trigger model that resets a branch counter to 0.", - "details": "When the trigger model reaches the Counter Reset block, it resets the count of the specified Branch on Counter block to zero.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "counter", - "description": "The block number of the counter that is to be reset", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 5, 2);trigger.model.setblock(4, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 3, 2);trigger.model.setblock(6, trigger.BLOCK_RESET_BRANCH_COUNT, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and take 5 readings.\n--- --Delay a second.\n--- --Loop three more times back to block 2.\n--- --Reset block 3 to 0.\n--- --Start the trigger model and wait for measurements to complete.\n--- --Print the number of readings in the buffer.\n--- --Output:\n--- --15\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "acal.count", - "webhelpfile": "43634.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of times autocalibration has been run.", - "details": "The number of times that autocalibration has been run since the last factory calibration. The count restarts at 1 after a factory calibration.", - "param_info": [ - { - "name": "value", - "description": "The number of times autocalibration has been run", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = acal.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.count);", - "description": "Returns the number of times autocalibration has been run.\n--- --Example output:\n--- --15\n" - } - ], - "related_commands": [ - "acal.run()" - ] - }, - { - "name": "acal.lastrun.internaltemp", - "webhelpfile": "43635.htm", - "signature": "", - "command_return": "temperature", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the internal temperature of the instrument when autocalibration was run.", - "details": "The temperature is displayed in Celsius (\u00b0C).", - "param_info": [ - { - "name": "temperature", - "description": "The internal temperature", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "temperature = acal.lastrun.internaltemp" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.lastrun.internaltemp);", - "description": "Returns the internal temperature of the instrument when autocalibration was last run.\n--- --Example output:\n--- --63.167084\n" - } - ], - "related_commands": [ - "acal.lastrun.tempdiff", - "acal.run()" - ] - }, - { - "name": "acal.lastrun.time", - "webhelpfile": "43636.htm", - "signature": "", - "command_return": "dateTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the date and time when autocalibration was last run.", - "details": "The date and time is returned in the format:MM/DD/YYYY HH:MM:SS.NNNNNNNNNWhere:", - "param_info": [ - { - "name": "dateTime", - "description": "The date and time", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dateTime = acal.lastrun.time" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.lastrun.time);", - "description": "Returns the date and time when the autocalibration was last run.\n--- --Example output:\n--- --08/11/2014 16:30:26.745369595\n" - } - ], - "related_commands": [ - "acal.run()" - ] - }, - { - "name": "acal.lastrun.time", - "webhelpfile": "43636_1.htm", - "signature": "", - "command_return": "dateTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the date and time when autocalibration was last run.", - "details": "The date and time is returned in the format:MM/DD/YYYY HH:MM:SS.NNNNNNNNNWhere:", - "param_info": [ - { - "name": "dateTime", - "description": "The date and time", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dateTime = acal.lastrun.time" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.lastrun.time);", - "description": "Returns the date and time when the autocalibration was last run.\n--- --Example output:\n--- --08/11/2014 16:30:26.745369595\n" - } - ], - "related_commands": [ - "acal.run()" - ] - }, - { - "name": "acal.run()", - "webhelpfile": "43640.htm", - "signature": "acal.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function immediately runs autocalibration and stores the constants.", - "details": "During autocalibration, a progress message is displayed on the front panel, all necessary autocalibration steps are completed, calibration constants are updated, and autocalibration last run information is updated. At completion, an event message is generated.When an autocalibration command is received, the instrument runs the autocalibration to completion before executing the next command.", - "param_info": [ - { - "name": "acal.run()", - "description": "Autocalibration starts running.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "acal.run()" - ], - "overloads": [], - "examples": [ - { - "example": "acal.run();", - "description": "Autocalibration starts running.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.digitize.unit", - "webhelpfile": "43717.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.UNIT_VOLT (digitize voltage function)smu.UNIT_AMP (digitize current function)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.", - "details": "The change in measurement units is displayed when the next measurement is made.", - "param_info": [ - { - "name": "value", - "description": "Units to display for the digitize voltage function", - "enum": "smu.UNIT_VOLT nil|smu.UNIT_OHM nil|smu.UNIT_WATT nil|smu.UNIT_AMP nil", - "type": "smudigitizeunitvalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizeunitfunction", - "range": "" - } - ], - "usage": [ - "value = smu.digitize.unit", - "smu.digitize.unit = value", - "value = smu.measure.getattribute(function, ATTR_DIGI_UNIT)", - "smu.measure.setattribute(function, ATTR_DIGI_UNIT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;smu.digitize.unit = smu.UNIT_WATT;", - "description": "Set the measure function to digitize voltage.\n--- --Set the units to display as watts.\n" - } - ], - "related_commands": [ - "smu.digitize.func" - ] - }, - { - "name": "trigger.model.load() - SimpleLoop", - "webhelpfile": "46034.htm", - "signature": "trigger.model.load(SimpleLoop, count, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes a specific number of measurements.", - "details": "This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the Count parameter.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger-model blocks in a list format.", - "param_info": [ - { - "name": "SimpleLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)", - "trigger.model.load(SimpleLoop, count, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses the SimpleLoop trigger-model template to do a capacitor test. This example produces 200 readings that have output similar to the following example:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LoopUntilEvent", - "webhelpfile": "46040.htm", - "signature": "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements until the specified event occurs.", - "details": "The event constant is the event that ends infinite triggering or ends readings set to occur before the trigger and start post-trigger readings. The trigger model makes readings until it detects the event constant. After the event, it makes a finite number of readings, based on the setting of the trigger position.The position marks the location in the reading buffer where the trigger will occur. The position is set as a percentage of the buffer capacity. The buffer captures measurements until a trigger occurs. When the trigger occurs, the buffer retains the percentage of readings specified by the position, then captures remaining readings until 100\u00a0percent of the buffer is filled. For example, if this is set to 75 for a reading buffer that holds 10,000 readings, the trigger model makes 2500 readings after it detects the source event. There are 7500 pre-trigger readings and 2500 post-trigger readings.The instrument makes two sets of readings. The first set is made until the trigger event occurs. The second set is made after the trigger event occurs, up to the number of readings calculated by the position parameter.You cannot have the event constant set at none when you run this trigger-model template.The following table lists the options that are available for triggerEvent.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "LoopUntilEvent", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "triggerEvent", - "description": "The event that ends infinite triggering or readings set to occur before the trigger; see Details", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "position", - "description": "The number of readings to make in relation to the size of the reading buffer; enter as a percentage (0% to 100%)", - "enum": "", - "type": "number", - "range": "(0% to 100%)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block (default)", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLoopUntilEventclear", - "range": "(default)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Initiate readings;trigger.model.load(\"LoopUntilEvent\", trigger.EVENT_DISPLAY, 50);trigger.model.initiate();", - "description": "Reset the instrument.\n--- --Set the instrument to measure current.\n--- --Load the LoopUntilEvent trigger model to make measurements until the front panel trigger key is pressed, then continue to make measurements equal to 50% of the reading buffer size.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - GradeBinning", - "webhelpfile": "46058.htm", - "signature": "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a grading operation.", - "details": "This trigger-model template allows you to grade components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the pass pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "GradeBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 1; range 1 to 15; default is\u00a01", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 2; range 1 to 15; default is\u00a02", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 3; range 1 to 15; default is\u00a04", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 4; range 1 to 15; default is\u00a08", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have passed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - SortBinning", - "webhelpfile": "46066.htm", - "signature": "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a sorting operation.", - "details": "This trigger-model template allows you to sort components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the all fail pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "SortBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 1; range 1 to 15; default is 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 2; range 1 to 15; default is 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 3; range 1 to 15; default is 4", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 4; range 1 to 15; default is 8", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have failed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.extravalues", - "webhelpfile": "46323.htm", - "signature": "bufferVar.extravalues[N]", - "command_return": "extraValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the additional values in a reading buffer.", - "details": "This attribute contains an additional value, such as the extra value written to a writable buffer. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extravalue", - "description": "The extra values for readings", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraValue = bufferVar.extravalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "acal.lastrun.tempdiff", - "webhelpfile": "46331.htm", - "signature": "", - "command_return": "temperature", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the difference between the internal temperature and the temperature when autocalibration was last run.", - "details": "The temperature is displayed in Celsius (\u00b0C).", - "param_info": [ - { - "name": "temperature", - "description": "The internal temperature", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "temperature = acal.lastrun.tempdiff" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.lastrun.tempdiff);", - "description": "Returns the difference between the temperature of the instrument when autocalibration was run and the present internal temperature.\n--- --Example output:\n--- --4.5678\n" - } - ], - "related_commands": [ - "acal.lastrun.internaltemp", - "acal.run()" - ] - }, - { - "name": "buffer.write.format()", - "webhelpfile": "46427.htm", - "signature": "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the units and number of digits of the readings that are written into the reading buffer.", - "details": "This command is valid when the buffer style is writable or full writable. When the buffer style is set to full writable, you can include an extra value.The format defines the units and the number of digits that are reported for the data. This command affects how the data is shown in the reading buffer and what is shown on the front-panel Home, Histogram, Reading Table, and Graph screens.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "units", - "description": "The units for the first measurement in the buffer index", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "bufferwriteformatunits", - "range": "" - }, - { - "name": "displayDigits", - "description": "The number of digits to use for the first measurement", - "enum": "buffer.DIGITS_3_5 nil|buffer.DIGITS_4_5 nil|buffer.DIGITS_5_5 nil|buffer.DIGITS_6_5 nil|buffer.DIGITS_7_5 nil|buffer.DIGITS_8_5 nil", - "type": "bufferwriteformatdisplayDigits", - "range": "" - }, - { - "name": "extraUnits", - "description": "The units for the second measurement in the buffer index; the selections are the same as units (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for units", - "enum": "", - "type": "bufferwriteformatunits", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "extraDigits", - "description": "The number of digits to use for the second measurement; the selections are the same as displayDigits (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for displayDigits", - "enum": "", - "type": "bufferwriteformatdisplayDigits", - "range": "(only valid for buffer style WRITABLE_FULL)" - } - ], - "usage": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)" - ], - "overloads": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1.0000000000e+00, Watt DC, 2.0000000000e+00, Watt DC, 3.0000000000e+00, Watt DC, 4.0000000000e+00, Watt DC, 5.0000000000e+00, Watt DC, 6.0000000000e+00, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.reading()" - ] - }, - { - "name": "buffer.write.reading()", - "webhelpfile": "46428.htm", - "signature": "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to write readings into the reading buffer.", - "details": "For buffers that are set to the writable buffer style:For buffers that are set to the full writable buffer style:This command writes the data you specify into a reading buffer. The reading buffer must be set to the writable or full writable style, which is set when you make the buffer.Data must be added in chronological order. If the time is not specified for a reading, it is set to one integer second after the last reading. As you write the data, the front-panel home screen updates and displays the reading you entered.The status parameter provides additional information about the reading. The options are shown in the following table.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "readingValue", - "description": "The first value that is recorded in the buffer index", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "extraValue", - "description": "A second value that is recorded in the buffer index (only valid for buffer style WRITABLE_FULL)", - "enum": "", - "type": "integer", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "seconds", - "description": "An integer that represents the seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractionalSeconds", - "description": "The portion of the time that represents the fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "status", - "description": "Additional information about the reading; see Details", - "enum": "", - "type": "readingStatus", - "range": "" - } - ], - "usage": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)" - ], - "overloads": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.startindex", - "webhelpfile": "56793.htm", - "signature": "bufferVar.startindex", - "command_return": "startIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the starting index in a reading buffer.", - "details": "Use this attribute to find the starting index in a reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Starting index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.startindex = startIndex " - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n" - } - ], - "related_commands": [ - "bufferVar.endindex", - "buffer.make()" - ] - }, - { - "name": "bufferVar.endindex", - "webhelpfile": "56794.htm", - "signature": "bufferVar.endindex", - "command_return": "endIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the last index in a reading buffer.", - "details": "Use this attribute to find the ending index in a reading buffer.", - "param_info": [ - { - "name": "endIndex", - "description": "Ending index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.endindex = endIndex" - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);smu.measure.read(test1);print(test1.startindex, test1.endindex);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n--- --Make six more measurements and store them in buffer test1.\n--- --Get the start index and end index of test1.\n--- --Output:\n--- --1, 12\n" - } - ], - "related_commands": [ - "bufferVar.startindex", - "buffer.make()" - ] - }, - { - "name": "smu.digitize.sense", - "webhelpfile": "63460.htm", - "signature": "", - "command_return": "sensing", - "type": "Attribute (RW)", - "default_value": "smu.SENSE_2WIRE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects local (2-wire) or remote (4-wire) sensing for the selected digitize function.", - "details": "This command determines if 2-wire (local) or 4-wire (remote) sensing is used.When you use 4-wire sensing, voltages are measured at the device under test (DUT). For the source voltage, if the sensed voltage is lower than the programmed amplitude, the voltage source increases the voltage until the sensed voltage is the same as the programmed amplitude. This compensates for IR drop in the output test leads.Using 4-wire sensing with voltage measurements eliminates any voltage drops that may be in the test leads between the Model 2461 and the DUT.When you are using 2-wire sensing, voltage is measured at the output connectors.When you are measuring resistance, you can enable 4-wire sensing to make 4-wire resistance measurements.When the output is off, 4-wire sensing is disabled and the instrument uses 2-wire sense, regardless of the sense setting. When the output is on, the selected sense setting is used.If the output is on when you change the sense setting, the output is turned off. ", - "param_info": [ - { - "name": "sensing", - "description": "Two-wire sensing", - "enum": "smu.SENSE_2WIRE nil|smu.SENSE_4WIRE nil", - "type": "smudigitizesensesensing", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smudigitizesensefunction", - "range": "" - } - ], - "usage": [ - "sensing = smu.digitize.sense", - "smu.digitize.sense = sensing", - "sensing = smu.measure.getattribute(function, ATTR_DIGI_SENSE)", - "smu.measure.setattribute(function, ATTR_DIGI_SENSE, sensing)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.digitize.func = smu.FUNC_CURRENT;smu.digitize.sense = smu.SENSE_4WIRE;", - "description": "Set the measurement function to digitize current.\n--- --Set the sense to 4-wire remote.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.contact.enable", - "webhelpfile": "63461.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether the contact check function is enabled or disabled on the instrument.", - "details": "Use this command to enable or disable the contact check function. To avoid getting error messages, contact check must be enabled before checking the status of instrument connections.", - "param_info": [ - { - "name": "state", - "description": "Enable contact check", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smucontactenablestate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smucontactenablefunction", - "range": "" - } - ], - "usage": [ - "smu.contact.enable = state", - "state = smu.contact.enable", - "state = smu.measure.getattribute(function, ATTR_MEAS_CCHK_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_CCHK_ENABLE, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.contact.enable = smu.ON;\u00a0;print(smu.contact.enable);", - "description": "Enable contact check operation.\n--- --\u00a0\n--- --Query whether contact check is enabled.\n--- --Output:\n--- --smu.ON\n--- --Indicates contact check is enabled.\n" - } - ], - "related_commands": [ - "smu.contact.check()", - "smu.contact.checkall()", - "smu.contact.threshold" - ] - }, - { - "name": "smu.contact.threshold", - "webhelpfile": "63462.htm", - "signature": "", - "command_return": "level", - "type": "Attribute (RW)", - "default_value": "smu.THRESHOLD_50_OHM\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the threshold value for contact resistance for the contact check status functions.", - "details": "The contact check functions indicate a failure when the connection path resistance exceeds the value specified by this command.This command can be sent when contact check isn't enabled. However, you must enable contact check before checking the status of connections.", - "param_info": [ - { - "name": "level", - "description": "The level of threshold resistance above which the contact check functions indicate a failure", - "enum": "smu.THRESHOLD_2_OHM nil|smu.THRESHOLD_15_OHM nil|smu.THRESHOLD_50_OHM nil", - "type": "smucontactthresholdlevel", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smucontactthresholdfunction", - "range": "" - } - ], - "usage": [ - "smu.contact.threshold = level", - "level = smu.contact.threshold", - "level = smu.measure.getattribute(function, ATTR_MEAS_CCHK_THRESHOLD)", - "smu.measure.setattribute(function, ATTR_MEAS_CCHK_THRESHOLD, level)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.contact.threshold = smu.THRESHOLD_15_OHM;\u00a0;print(smu.contact.threshold);", - "description": "Set the contact check function to indicate a failure if resistance is greater than 15 \u03a9.\n--- --Query the contact check threshold setting.\n--- --Output: \n--- --smu.THRESHOLD_15_OHM\n--- --Indicates that the contact check threshold is set to 15\u00a0\u03a9.\n" - } - ], - "related_commands": [ - "smu.contact.check()", - "smu.contact.checkall()", - "smu.contact.enable" - ] - }, - { - "name": "smu.contact.check()", - "webhelpfile": "63463.htm", - "signature": "smu.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function indicates whether one or more connections failed the contact check operation.", - "details": "result = smu.contact.check()Use this function to check for excessive contact resistance at any of the connections to the device under test (DUT).Use the print() command to query the result of the contact check operation. The query returns false if one or more connections exceed the threshold resistance level set by the smu.contact.threshold attribute, or it returns true if no connections exceed that value. If you get a failed indication when sending this function, you can use the smu.contact.checkall() function to determine which connection failed the contact check test.Sending this command when contact check is not enabled results in an error.", - "param_info": [ - { - "name": "result", - "description": "The result of the contact check operation", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "result = smu.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.contact.enable = smu.ON;print(smu.contact.check());", - "description": "Enable contact check\n--- --Check connections for excessive contact resistance.\n--- --Output:\n--- --true\n--- --Indicates that all connections passed the contact check operation.\n" - } - ], - "related_commands": [ - "smu.contact.checkall()", - "smu.contact.enable", - "smu.contact.threshold" - ] - }, - { - "name": "smu.contact.checkall()", - "webhelpfile": "63464.htm", - "signature": "smu.contact.checkall()", - "command_return": "high, low, guard", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function checks the high, low, and guard connections for excessive contact resistance.", - "details": "Use this command to check the high, low, and guard connections to the device under test (DUT) for excessive contact resistance. Use the print() command to query the result of the contact check operation. For each of the three connections, this command returns false if the threshold resistance exceeds the level specified by the smu.contact.threshold command, or true if it does not exceed that value.If you get a failed indication when sending the smu.contact.check() function, use this function to determine which connection failed.Sending this command when contact check is not enabled results in an error.", - "param_info": [ - { - "name": "high", - "description": "The result of the contact check operation for the high connection", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "low", - "description": "The result of the contact check operation for the low connection", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "guard", - "description": "The result of the contact check operation for the guard connection", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "high, low, guard = smu.contact.checkall()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.contact.enable = smu.ON;print(smu.contact.checkall());", - "description": "Enable contact check.\n--- --Get the status of high, low, and guard connections for contact check.\n--- --Output:\n--- --false false true\n--- --Indicates that the high and low connections exceeded the specified contact check resistance threshold value, but the guard connection did not exceed that value.\n" - } - ], - "related_commands": [ - "smu.contact.check()", - "smu.contact.enable", - "smu.contact.threshold" - ] - }, - { - "name": "smu.source.pulse.level", - "webhelpfile": "63469.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects a fixed amplitude for the selected source function when pulsing.", - "details": "This command sets the output level of the voltage or current source pulse when pulsing.The sign of the source level dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.If a manual source range is selected, the level cannot exceed the specified range. For example, if the voltage source is on the 2\u00a0V range, you cannot set the voltage source level to 3\u00a0V. When autorange is selected, the amplitude can be set to any level supported by the instrument.Use this command with a source configuration list to build a custom pulse sweep list that has unique pulse level points. Then use that custom source configuration list as a parameter to the smu.source.pulsesweeplist() command to configure the instrument for the pulse sweep.", - "param_info": [ - { - "name": "value", - "description": "The source pulse level to set", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcepulselevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.pulse.level", - "smu.source.pulse.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_PULSE_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_PULSE_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.configlist.create(\"CustomVoltSweep\");smu.source.pulse.level = 1.17;smu.source.configlist.store(\"CustomVoltSweep\");smu.source.pulse.level = 1.27;smu.source.configlist.store(\"CustomVoltSweep\");smu.source.pulse.level = 1.33;smu.source.configlist.store(\"CustomVoltSweep\");smu.source.pulse.level = 1.39;smu.source.configlist.store(\"CustomVoltSweep\");smu.source.pulsesweeplist(\"CustomVoltSweep\", 0.03, smu.OFF, defbuffer1, 1, 3, 0, .005);", - "description": "Set the source function to voltage and create a source list called CustomVoltSweep.\n--- --Set the pulse level to 1.17 V and store that pulse level at the next index (1) in CustomVoltSweep.\n--- --Set the pulse level to 1.27 V and store that pulse level at the next index (2) in CustomVoltSweep.\n--- --Set the pulse level to 1.33 V and store that pulse level at the next index (3) in CustomVoltSweep.\n--- --Set the pulse level to 1.39 V and store that pulse level at the next index (4) in CustomVoltSweep.\n--- --Creates a pulse sweep using the CustomVoltSweep source list that steps through four pulse levels three times, for a total of 12 pulses. Each pulse has a width of 30 ms and an off time of 5 ms. Readings are not taken during this pulse sweep. Start the sweep at index 1. Then query the pulse list. Output: 1.17,1.270000E+00,1.330000E+00,1.390000E+00\n" - } - ], - "related_commands": [ - "smu.source.autorange", - "smu.source.level", - "smu.source.pulse.xlimit.level", - "smu.source.range" - ] - }, - { - "name": "smu.source.pulsetrain()", - "webhelpfile": "63470.htm", - "signature": "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime, xBiasLimit, xPulseLimit, failAbort)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function defines a sequence of source pulses and creates a trigger model to generate the pulse train.", - "details": "Use this command to set up and configure settings for a pulse train.Before configuring a pulse operation, configure your measure settings. Pulse operations use the measure settings that were last defined before the pulse operation; you may get unexpected results if you do not define the measure settings first.The bias level must be within the normal DC operating area (not the pulse-only area) of the operating boundaries. It must be low enough that it does not exceed the power settings defined by the bias limit and pulse limit parameters.The pulse level is not limited to the normal operating area; it can be set to any value within the operating boundaries. When the pulse level is set to a value in the pulse-only operating area, the pulse width is limited.The bias limit is limited to the normal operating area and is affected by either the maximum pulse level or bias level setting, whichever is greater in magnitude.The pulse limit is not limited to the normal operating area.The name of the source configuration list determines the name of the measure configuration list; Meas is appended to the beginning of the name. If the name of your configuration list is greater than 28 characters, it is truncated to include only the first 28 characters (including the prefix Meas that is added for the measure configuration list). For example, if the source configuration list is named VoltagePulseTrainSweepList (26 characters), the resulting measure configuration list is named MeasVoltagePulseTrainSweepList (30 characters). If the source configuration list is named MyLongPulseNameSweepConfigList (30 characters), the resulting measure configuration list is MeasMyLongPulseNameSweepConfigLi (32 characters).", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "biasLevel", - "description": "Output level the instrument sources before the first pulse and returns to between pulses (delay and off time)", - "enum": "", - "type": "number", - "range": "(delay and off time)" - }, - { - "name": "pulseLevel", - "description": "The amplitude current or voltage from zero (not from the bias level)", - "enum": "", - "type": "number", - "range": "(not from the bias level)" - }, - { - "name": "pulseWidth", - "description": "The time at the amplitude level for each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "count", - "description": "The number of pulses in the pulse train; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcepulstraincount | number", - "range": "" - }, - { - "name": "measEnable", - "description": "Enable or disable measurements at the top of each pulse", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsetrainmeasEnable", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "sDelay", - "description": "The amount of time that the instrument stays at bias level before each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "offTime", - "description": "The amount of time that the instrument stays at bias level after each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "xBiasLimit", - "description": "The current or voltage limit for the defined bias level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "xPulseLimit", - "description": "The current or voltage limit for the defined pulse level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "failAbort", - "description": "Determines if the pulse train is stopped immediately if a limit is exceeded; options\u00a0are", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsetrainfailAbort", - "range": "" - } - ], - "usage": [ - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime, xBiasLimit)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime, xBiasLimit, xPulseLimit)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime, xBiasLimit, xPulseLimit, failAbort)" - ], - "overloads": [ - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime, xBiasLimit)", - "smu.source.pulsetrain(configListName, biasLevel, pulseLevel, pulseWidth, count, measEnable, bufferName, sDelay, offTime, xBiasLimit, xPulseLimit)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_CURRENT;smu.source.readback = smu.ON;smu.digitize.func = smu.FUNC_DIGITIZE_VOLTAGE;smu.digitize.range = 20;smu.digitize.samplerate = 25000;smu.source.pulsetrain(\"DigitizeTrain\", -1, -3, 10e-3, 3, smu.ON, defbuffer1, 0, 90e-3, 15, 15);trigger.model.initiate();", - "description": "Reset the instrument to its default settings.\n--- --Set the source function to current and turn on source readback.\n--- --Set the digitize function to voltage and the digitize voltage range to 20 V.\n--- --Set the digitize sample rate to 25000 readings per second.\n--- --Set up a pulse train with a bias level of -1 A and a pulse level of -3 A. Set the train to create three pulses with a pulse length of 10\u00a0ms and an off time of 90 ms. Set the pulse voltage limit and the bias voltage limit to 15 V.\n--- --Start the pulse train.\n" - } - ], - "related_commands": [ - "smu.source.pulsesweeplist()" - ] - }, - { - "name": "smu.source.pulsesweeplinearstep()", - "webhelpfile": "63471.htm", - "signature": "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear source pulse sweep configuration list model with a fixed number of steps.", - "details": "Before configuring a pulse operation, configure your measure settings. Pulse operations use the measure settings that were last defined before the pulse operation; you may get unexpected results if you do not define the measure settings first.When the pulse sweep is started, the instrument sources a specific voltage or current voltage to the device under test (DUT). A pulse is output for each step of the pulse sweep. When the pulse sweep command is sent, it deletes the existing trigger model and creates a trigger model with a uniform series of ascending or descending voltage or current changes, called steps. To run the pulse sweep, initiate the trigger model.The pulse sweep continues until the source outputs the stop level, which is calculated from the number of steps. If measurements are enabled, a measurement is also made for each step of the pulse sweep (including the start and stop levels). At this level, the instrument performs another measurement and then stops the pulse sweep.The instrument uses the step size parameter to determine the number of source level changes. The source level changes in equal steps from the start level to the stop level. To avoid a setting conflicts error, make sure the step size is greater than the start value and less than the stop value. To calculate the number of source-measure points in a sweep, use the following formula: Points = [(Stop - Start) / Step] + 1The name of the source configuration list determines the name of the measure configuration list; Meas is appended to the beginning of the name. If the name of your configuration list is greater than 28 characters, it is truncated to include only the first 28 characters (including the prefix Meas that is added for the measure configuration list). For example, if the source configuration list is named VoltagePulseLinearSweepList (27 characters), the resulting measure configuration list is named MeasVoltagePulseLinearSweepList (31 characters). If the source configuration list is named MyLongPulseNameSweepConfigList (30 characters), the resulting measure configuration list is MeasMyLongPulseNameSweepConfigLi (32 characters).", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "biasLevel", - "description": "Output level the instrument sources before the first pulse and returns to between pulses (delay and off time)", - "enum": "", - "type": "number", - "range": "(delay and off time)" - }, - { - "name": "start", - "description": "The voltage or current source level at which the pulse sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current source level at which the pulse sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "step", - "description": "The step size at which the source level will change; step size must be greater than 0; to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "pulseWidth", - "description": "The time at the amplitude level for each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measEnable", - "description": "Enable or disable measurements at the top of each pulse", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplinearstepmeasEnable", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "sDelay", - "description": "The amount of time that the instrument stays at bias level before each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "offTime", - "description": "The amount of time that the instrument stays at bias level after each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "count", - "description": "The number of pulse sweeps; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcepulsesweeplinearstepcount | number", - "range": "" - }, - { - "name": "xBiasLimit", - "description": "The current or voltage limit for the defined bias level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "xPulseLimit", - "description": "The current or voltage limit for the defined pulse level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "failAbort", - "description": "Determines if the sweep is stopped immediately if a limit is exceeded; options are", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplinearstepfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcepulsesweeplinearstepdual", - "range": "" - } - ], - "usage": [ - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual)" - ], - "overloads": [ - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit)", - "smu.source.pulsesweeplinearstep(configListName, biasLevel, start, stop, step, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 3;smu.source.readback = smu.OFF;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 10;smu.measure.autozero.enable = smu.OFF;smu.measure.nplc = .01;smu.source.pulsesweeplinearstep(\"CurrPulseLinSweepList\",0 ,-3, 3, .25, 10e-3, smu.ON, defbuffer1, 0, 100e-3, 1, 10, 10, smu.OFF, smu.OFF);trigger.model.initiate();", - "description": "Reset the instrument to its default settings.\n--- --Set the source function to current and the source range to 3 A.\n--- --Turn source readback off.\n--- --Set the measure function to voltage and the measure range to 10 V.\n--- --Turn off autozero and set the NPLC to .01.\n--- --Set up a linear pulse step sweep from -3 A to 3 A in 250 mA steps. Set the pulse width to 10 ms, the off time to 100 ms and the bias level to 0 A.\n--- --Start the pulse sweep.\n" - } - ], - "related_commands": [ - "smu.source.sweeplinearstep()" - ] - }, - { - "name": "smu.source.pulsesweeplinear()", - "webhelpfile": "63472.htm", - "signature": "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual) ", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear pulse sweep for a fixed number of pulse points.", - "details": "Before configuring a pulse operation, configure your measure settings. Pulse operations use the measure settings that were last defined before the pulse operation; you may get unexpected results if you do not define the measure settings first.When the pulse sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A pulse is output for each point of the sweep. If measurements are enabled, a measurement is also made for each point of the sweep.When the pulse sweep command is sent, it clears any existing trigger models, creates a source and measure pulse configuration list, and populates the trigger model. To run the pulse sweep, initiate the trigger model.The pulse sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the pulse sweep trigger model.The name of the source configuration list determines the name of the measure configuration list; Meas is appended to the beginning of the name. If the name of your configuration list is greater than 28 characters, it is truncated to include only the first 28 characters (including the prefix Meas that is added for the measure configuration list). For example, if the source configuration list is named VoltagePulseLinearSweepList (27 characters), the resulting measure configuration list is named MeasVoltagePulseLinearSweepList (31 characters). If the source configuration list is named MyLongPulseNameSweepConfigList (30 characters), the resulting measure configuration list is MeasMyLongPulseNameSweepConfigLi (32 characters).", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "biasLevel", - "description": "Output level the instrument sources before the first pulse and returns to between pulses (delay and off time)", - "enum": "", - "type": "number", - "range": "(delay and off time)" - }, - { - "name": "start", - "description": "The voltage or current source level at which the pulse sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current source level at which the pulse sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of pulse-measure points between the start and stop values of the pulse sweep (2 to 1e6)", - "enum": "", - "type": "number", - "range": "(2 to 1e6)" - }, - { - "name": "pulseWidth", - "description": "The time at the amplitude level for each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measEnable", - "description": "Enable or disable measurements at the top of each pulse", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplinearmeasEnable", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "sDelay", - "description": "The amount of time that the instrument stays at bias level before each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "offTime", - "description": "The amount of time that the instrument stays at bias level after each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "count", - "description": "The number of pulse sweeps; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcepulsesweeplinearcount | number", - "range": "" - }, - { - "name": "xBiasLimit", - "description": "The current or voltage limit for the defined bias level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "xPulseLimit", - "description": "The current or voltage limit for the defined pulse level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "failAbort", - "description": "Determines if the sweep is stopped immediately if a limit is exceeded; options are", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplinearfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcepulsesweeplineardual", - "range": "" - } - ], - "usage": [ - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, MeasEnable, bufferName, sDelay, offTime, count)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, MeasEnable, bufferName, sDelay, offTime, count, xBiasLimit)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual) " - ], - "overloads": [ - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, MeasEnable, bufferName, sDelay, offTime, count)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, MeasEnable, bufferName, sDelay, offTime, count, xBiasLimit)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit)", - "smu.source.pulsesweeplinear(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;smu.measure.nplc = 0.01;smu.measure.autozero.enable = smu.OFF;smu.source.pulsesweeplinear(\"VoltLinSweep\", 0, 0, 10, 20, 2e-3);trigger.model.initiate();", - "description": "Reset the instrument to its default settings.\n--- --Set the source function to voltage and the source range to 20\u00a0V.\n--- --Set up a linear pulse sweep that sweeps from 0 to 10 V in 20 steps with a pulse width of 2\u00a0ms and a sweep count of 1. Name the configuration list that is created for this sweep VoltLinSweep.\n--- --Set the measure function to current and the current range to 100 uA.\n--- --Start the pulse sweep.\n" - } - ], - "related_commands": [ - "smu.source.pulsesweeplist()", - "trigger.model.initiate()" - ] - }, - { - "name": "smu.source.pulsesweeplog()", - "webhelpfile": "63473.htm", - "signature": "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a logarithmic pulse sweep for a set number of source points.", - "details": "Before configuring a pulse operation, configure your measure settings. Pulse operations use the measure settings that were last defined before the pulse operation; you may get unexpected results if you do not define the measure settings first.When the pulse sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the pulse sweep.When the pulse sweep command is sent, it clears the existing trigger model and creates a new trigger model. To run the pulse sweep, initiate the trigger model.The pulse sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the pulse sweep.When you specify a delay, a delay block is added to the pulse sweep trigger model.The asymptote changes the inflection of the pulse sweep curve and allows it to sweep through zero. You can use the asymptote parameter to customize the inflection and offset of the source value curve. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep. It must be outside of the range defined by the starting and ending values.The name of the source configuration list determines the name of the measure configuration list; Meas is appended to the beginning of the name. If the name of your configuration list is greater than 28 characters, it is truncated to include only the first 28 characters (including the prefix Meas that is added for the measure configuration list). For example, if the source configuration list is named VoltPulseLogarithSweepList (26 characters), the resulting measure configuration list is named MeasVoltPulseLogarithSweepList (30 characters). If the source configuration list is named MyLongPulseNameSweepConfigList (30 characters), the resulting measure configuration list is MeasMyLongPulseNameSweepConfigLi (32 characters).", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "biasLevel", - "description": "Output level the instrument sources before the first pulse and returns to between pulses (delay and off time)", - "enum": "", - "type": "number", - "range": "(delay and off time)" - }, - { - "name": "start", - "description": "The voltage or current source level at which the pulse sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current source level at which the pulse sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of pulse-measure points between the start and stop values of the pulse sweep (2 to 1e6)", - "enum": "", - "type": "number", - "range": "(2 to 1e6)" - }, - { - "name": "pulseWidth", - "description": "The time at the amplitude level for each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measEnable", - "description": "Enable or disable measurements at the top of each pulse", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplogmeasEnable", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "sDelay", - "description": "The amount of time that the instrument stays at bias level before each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "offTime", - "description": "The amount of time that the instrument stays at bias level after each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "count", - "description": "The number of pulse sweeps; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcepulsesweeplogcount | number", - "range": "" - }, - { - "name": "xBiasLimit", - "description": "The current or voltage limit for the defined bias level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "xPulseLimit", - "description": "The current or voltage limit for the defined pulse level", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "failAbort", - "description": "Determines if the sweep is stopped immediately if a limit is exceeded; options are", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplogfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcepulsesweeplogdual", - "range": "" - }, - { - "name": "asymptote", - "description": "Default is 0; see Details", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual, asymptote)" - ], - "overloads": [ - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort)", - "smu.source.pulsesweeplog(configListName, biasLevel, start, stop, points, pulseWidth, measEnable, bufferName, sDelay, offTime, count, xBiasLimit, xPulseLimit, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 100;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 1;smu.source.readback = smu.ON;smu.measure.autozero.enable = smu.ON;smu.measure.nplc = .1;smu.source.pulsesweeplog(\"VoltLogSweep\", 0, 1, 100, 50, 20e-3, smu.ON, defbuffer1, 0, 80e-3, 5, 1, 1);trigger.model.initiate();", - "description": "Reset the instrument to its default settings.\n--- --Set the source function to voltage and the source voltage range to 100 V.\n--- --Set the measure function to current and the measure current range to 1 A.\n--- --Turn on source readback, enable autozero and set the NPLC to 0.1.\n--- --Set up a logarithmic sweep from 1 V to 100 V in 50 steps. Set the pulse width to 20 ms, the off time to 80 ms, and repeat the sweep five times.\n--- --Start the pulse sweep.\n" - } - ], - "related_commands": [ - "smu.source.pulsesweeplist()" - ] - }, - { - "name": "smu.source.pulsesweeplist()", - "webhelpfile": "63474.htm", - "signature": "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count, sDelay, offTime, failAbort)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a pulse sweep based on a configuration list, which allows you to customize the sweep.", - "details": "This command allows you to set up a custom pulse sweep using a configuration list to specify the pulse levels.Before configuring a pulse operation, configure your measure settings. Pulse operations use the measure settings that were last defined before the pulse operation; you may get unexpected results if you do not define the measure settings first.When you specify a delay, a delay block is added to the pulse sweep trigger model. A source configuration list must be created before you send this command. The name of the source configuration list determines the name of the measure configuration list; Meas is appended to the beginning of the name. If the name of your configuration list is greater than 28 characters, it is truncated to include only the first 28 characters (including the prefix Meas that is added for the measure configuration list). For example, if the source configuration list is named CurrentPulseCustomSweepList (27 characters), the resulting measure configuration list is named MeasCurrentPulseCustomSweepList (31 characters). If the source configuration list is named MyLongPulseNameSweepConfigList (30 characters), the resulting measure configuration list is MeasMyLongPulseNameSweepConfigLi (32 characters)To run the pulse sweep, initiate the trigger model.", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "pulseWidth", - "description": "The time at the amplitude level for each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measEnable", - "description": "Enable or disable measurements at the top of each pulse", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplistmeasEnable", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "startIndex", - "description": "The index in the configuration list where the pulse sweep starts; default is 1", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "count", - "description": "The number of pulse sweeps; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcepulsesweeplistcount | number", - "range": "" - }, - { - "name": "sDelay", - "description": "The amount of time that the instrument stays at bias level before each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "offTime", - "description": "The amount of time that the instrument stays at bias level after each pulse (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "failAbort", - "description": "Determines if the sweep is stopped immediately if a limit is exceeded; options are", - "enum": "smu.ON nil|smu.OFF nil", - "type": "smusourcepulsesweeplistfailAbort", - "range": "" - } - ], - "usage": [ - "smu.source.pulsesweeplist(configListName, pulseWidth)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count, sDelay)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count, sDelay, offTime)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count, sDelay, offTime, failAbort)" - ], - "overloads": [ - "smu.source.pulsesweeplist(configListName, pulseWidth)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count, sDelay)", - "smu.source.pulsesweeplist(configListName, pulseWidth, measEnable, bufferName, start_index, count, sDelay, offTime)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"CurrPulseListSweep\");smu.source.func = smu.FUNC_DC_CURRENT;smu.source.level = 0;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 10;smu.source.pulse.vlimit.level = 10;smu.source.pulse.level = .5;smu.source.configlist.store(\"CurrPulseListSweep\");smu.source.pulse.level = .3;smu.source.configlist.store(\"CurrPulseListSweep\");smu.source.pulse.level = .7;smu.source.configlist.store(\"CurrPulseListSweep\");smu.source.pulse.level = .1;smu.source.configlist.store(\"CurrPulseListSweep\");smu.source.pulse.level = .6;smu.source.configlist.store(\"CurrPulseListSweep\");smu.source.pulsesweeplist(\"CurrPulseListSweep\", 100e-3, smu.ON, defbuffer1, 1, 1,; 0, 100e-3, smu.ON);trigger.model.initiate();", - "description": "Reset the instrument to its default settings.\n--- --Create a source configuration list called CurrPulseListSweep.\n--- --Set the source function to current, the source current range to 1 A.\n--- --Set the measure function to voltage, the measure range to 10 V and the source pulse limit to 10\u00a0V.\n--- --Set the source current level to 500 mA and save the source settings to CurrPulseListSweep.\n--- --Set the source current level to 300 mA and save the source settings to CurrPulseListSweep.\n--- --Set the source current level to 700 mA and save the source settings to CurrPulseListSweep.\n--- --Set the source current level to 100 mA and save the source settings to CurrPulseListSweep.\n--- --Set the source current level to 600 mA and save the source settings to CurrPulseListSweep.\n--- --\u00a0\n--- --Sets up a pulse sweep that uses the entries from CurrPulseListSweep. Set a pulse width of 100 ms and an off time of 100 ms. Start the sweep at index 1 and save the measure results to defbuffer1.\n--- --Set a source delay of 1\u00a0ms.\n--- --Start the pulse sweep.\n" - } - ], - "related_commands": [ - "smu.source.sweeplist()", - "trigger.model.initiate()" - ] - }, - { - "name": " trigger.BLOCK_SOURCE_PULSE_OUTPUT", - "webhelpfile": "63477.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_PULSE_OUTPUT, state)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a pulse trigger block that turns the pulse source on or off. ", - "details": "When you list trigger blocks, this block is listed as PULSE_OUTPUT.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "Turn the source pulse off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "triggermodelsetblocktriggerBLOCK_SOURCE_PULSE_OUTPUTstate", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_PULSE_OUTPUT, state)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(5, trigger.BLOCK_SOURCE_PULSE_OUTPUT, smu.ON);", - "description": "Set trigger model to turn the source on when it reaches block 4 and source pulse on when it reaches block 5.\n" - }, - { - "example": "print(trigger.model.getblocklist());", - "description": "Query the configuration of the blocks in the trigger model.\n--- --Output:\n--- --4) SOURCE_OUTPUT OUTPUT: ON\n--- --5) SOURCE_PULSE_OUTPUT PULSE OUTPUT: ON\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_SOURCE_OUTPUT" - ] - }, - { - "name": "smu.source.pulse.xlimit.level", - "webhelpfile": "63723.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 105 \u00b5ACurrent: 7.35 V\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source limit for pulsed output for the selected function when pulsing.", - "details": "This command sets the source limit for pulse outputs. The Model 2461 cannot source pulse levels that exceed this limit.The values that can be set for this command are limited by the setting for the overvoltage protection limit. Also, if an interlock is not installed, the values are limited.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be more than 1\u00a0percent of the measurement range. If you set the measurement range to be automatically selected, the measurement range is selected based on the pulse and bias limits.If you change the source range to a level that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated.Limits are absolute values.You can use the smu.source.xlimit.tripped command to check the limit state of the pulse source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcepulsexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "smu.source.pulse.xlimit.level = value", - "value = smu.source.pulse.xlimit.level", - "value = smu.source.getattribute(function, ATTR_SRC_PULSE_LIMIT)", - "smu.source.setattribute(function, ATTR_SRC_PULSE_LIMIT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.pulse.ilimit.level = 1;print(smu.source.pulse.ilimit.level);", - "description": "Set the source function to voltage with the pulse current limit set to 1\u00a0A.\n--- --Query the source pulse current limit setting.\n--- --Output:\n--- --1\n--- --Indicates that the source pulse current limit is 1 A.\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "trigger.model.pause()", - "webhelpfile": "72471.htm", - "signature": "trigger.model.pause()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function pauses a running trigger model.", - "details": "This command pauses the trigger model.To continue the trigger model, send the resume command.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.pause()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.resume()" - ] - }, - { - "name": "trigger.model.resume()", - "webhelpfile": "73512.htm", - "signature": "trigger.model.resume()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function continues a paused trigger model.", - "details": "This command continues running the trigger model operation if the trigger model was paused.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.resume()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.pause()" - ] - }, - { - "name": "buffer.math()", - "webhelpfile": "73595.htm", - "signature": "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to run a mathematical expression on a measurement. The expression is applied when the measurement is placed in the reading buffer.", - "details": "", - "param_info": [ - { - "name": "readingBuffer", - "description": "The name of the reading buffer; the reading buffer selected must be set to the style FULL", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "unit", - "description": "The units to be applied to the value generated by the expression", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "buffermathunit", - "range": "" - }, - { - "name": "constant0", - "description": "The constant to be used for c0 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant1", - "description": "The constant to be used for c1 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant2", - "description": "The constant to be used for c2 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant3", - "description": "The constant to be used for c3 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant4", - "description": "The constant to be used for c4 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant5", - "description": "The constant to be used for c5 in the expression", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)" - ], - "overloads": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)" - ], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;\u00a0;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);\u00a0;print(\"Extra value reading 1: \", mathExp.extravalues[1]);print(\"Extra value reading 2: \", mathExp.extravalues[2]);print(\"Extra value reading 3: \", mathExp.extravalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: 6.3863430578e-05\n--- --Reading: 6.7818055872e-05\n--- --Reading: 1.9871571784e-05\n--- --Extra value reading 1: 6.3863430578e-05\n--- --Extra value reading 2: 4.3310937031e-09\n--- --Extra value reading 3: 1.3476513655e-09\n" - } - ], - "related_commands": [ - "buffer.unit()" - ] - }, - { - "name": "buffer.unit()", - "webhelpfile": "76401.htm", - "signature": "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create up to three custom units of measure for use in buffers.", - "details": "You can use custom units of measures in buffer math and writable buffers.If you specify more than two characters, the additional characters are ignored. Some characters are converted to other symbols:This unit is reset when power is cycled. It is not affected by reset.", - "param_info": [ - { - "name": "UNIT_CUSTOMN", - "description": "Custom unit user can create, The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "bufferCustomUnit", - "range": "" - }, - { - "name": "N", - "description": "The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "unitOfMeasure", - "description": "A string that defines the custom unit; up to three characters; defaults are X for custom unit 1, Y for unit 2, and Z for unit 3", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.unit(buffer.UNIT_CUSTOM1, \"fb\") ;\u00a0;buffer.math(mathExp, buffer.UNIT_CUSTOM1, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading \"..x..\":\", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);for x = 1, 3 do ; print(\"Extra value reading \"..x..\":\", mathExp.extravalues[x]);end;", - "description": "Instrument has terminals set to FRONT.\n--- --Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the customer 1 buffer unit to fb.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make 3 readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading 1: 0.00015611271869\n--- --Reading 2: 9.0539004907e-05\n--- --Reading 3: 0.30001141669554\n--- --Extra value reading 1: 0.00015611271869\n--- --Extra value reading 2: 1.4134290203e-08\n--- --Extra value reading 3: 1.0336562635e-08\n" - } - ], - "related_commands": [ - "buffer.math()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.extraformattedvalues", - "webhelpfile": "81089.htm", - "signature": "bufferVar.extraformattedvalues[N]", - "command_return": "extraFormat", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement and the unit of measure of the additional values in a reading buffer.", - "details": "This attribute contains the measurement and the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraFormat", - "description": "The measurement and unit of measure of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraFormat = bufferVar.extraformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(400, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;display.changescreen(display.SCREEN_READING_TABLE);print(\"Extra value reading 1: \", mathExp.extraformattedvalues[1]);print(\"Extra value reading 2: \", mathExp.extraformattedvalues[2]);print(\"Extra value reading 3: \", mathExp.extraformattedvalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 400 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: \t7.1233589551e-06\n--- --Reading: \t7.1233080234e-06\n--- --Reading: \t7.2616603575e-06\n--- --Extra value reading 1: \t+7.1233590 u\n--- --Extra value reading 2: \t+50.741880 p\n--- --Extra value reading 3: \t+51.727043 p\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.extravalueunits", - "webhelpfile": "81090.htm", - "signature": "bufferVar.extravalueunits[N]", - "command_return": "extraUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of the additional values in a reading buffer.", - "details": "This attribute contains the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraUnits", - "description": "The units of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraUnits = bufferVar.extravalueunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.extravalueunits);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and extra value units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.activebuffer", - "webhelpfile": "81840.htm", - "signature": "", - "command_return": "bufferName", - "type": "Attribute (RW)", - "default_value": "defbuffer1\n", - "tsp_link": "Yes\n", - "description": "This attribute determines which buffer is used for measurements that are displayed on the front panel.", - "details": "The buffer defined by this command is used to store measurements data and is shown in the reading buffer indicator on the home screen of the instrument.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of the buffer to make active", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferName = display.activebuffer", - "display.activebuffer = bufferName" - ], - "overloads": [], - "examples": [ - { - "example": "display.activebuffer = buffer2;", - "description": "Set the front panel to use buffer2 as the active reading buffer.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.continuous", - "webhelpfile": "88463.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "trigger.CONT_AUTO\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the trigger mode setting after bootup.", - "details": "Conditions must be valid before continuous measurements can start.When the restart parameter is selected, the instrument is placed in local mode, aborts any running scripts, and aborts any trigger models that are running. If the command is in a script, it is the last command that runs before the script is aborted. The restart parameter is not stored in nonvolatile memory, so it does not affect start up behavior.The off and automatic parameters are stored in nonvolatile memory, so they affect start up behavior.", - "param_info": [ - { - "name": "setting", - "description": "Do not start continuous measurements after boot", - "enum": "trigger.CONT_OFF nil|trigger.CONT_AUTO nil|trigger.CONT_RESTART nil", - "type": "triggercontinuoussetting", - "range": "" - } - ], - "usage": [ - "setting = trigger.continuous", - "trigger.continuous = setting" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.continuous = trigger.CONT_OFF;", - "description": "When the instrument starts up, the measurement method is set to idle.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.autorangerebound", - "webhelpfile": "88860.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument restores the measure range to match the limit range after making a measurement.", - "details": "When autorange rebound is enabled, it prevents the source from being limited to a value that is below the source limit. After an autoranged measurement is made, the measure range is restored to match the limit range once the autoranged measurement is complete. This ensures that the source does not limit at less than the full limit setting.", - "param_info": [ - { - "name": "state", - "description": "Do not restore the measurement range after each measurement", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangereboundstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangereboundfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autorangerebound", - "smu.measure.autorangerebound = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_RANGE_REBOUND)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_REBOUND, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;smu.measure.autorangerebound = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n--- --Set the measure range to be automatically restored to match the source limit value after each measurement.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.interlock.enable", - "webhelpfile": "88873.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the output can be turned on when the interlock is not engaged.", - "details": "", - "param_info": [ - { - "name": "state", - "description": "Allow the output to be turned on when the interlock is not engaged", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlockenablestate", - "range": "" - } - ], - "usage": [ - "state = smu.interlock.enable", - "smu.interlock.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "smu.interlock.enable = smu.ON;", - "description": "The source output is disabled unless the interlock is engaged.\n" - } - ], - "related_commands": [ - "smu.interlock.tripped" - ] - }, - { - "name": "available()", - "webhelpfile": "89066.htm", - "signature": "available(functionality)", - "command_return": "presence", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks for the presence of specific instrument functionality.", - "details": "", - "param_info": [ - { - "name": "presence", - "description": "If the functionality is present, returns true; if not, returns false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "functionality", - "description": "The functionality to check for", - "enum": "", - "type": "functionality", - "range": "" - } - ], - "usage": [ - "presence = available(functionality)" - ], - "overloads": [], - "examples": [ - { - "example": "print(available(gpib));", - "description": "Returns true if GPIB communications are available. Returns false if GPIB communications are not available.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.getattribute()", - "webhelpfile": "91266.htm", - "signature": "smu.measure.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil|smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smumeasuregetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to smu.measure.setattribute() for available settings", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "()" - } - ], - "usage": [ - "value = smu.measure.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_RANGE));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_NPLC));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_DIGITS));", - "description": "Retrieve the range, NPLC, and digits settings for the DC voltage function.\n--- --Example return:\n--- --0.02\n--- --1\n--- --smu.DIGITS_4_5\n" - } - ], - "related_commands": [ - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.measure.configlist.storefunc()", - "webhelpfile": "91273.htm", - "signature": "smu.measure.configlist.storefunc(listName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a measure function into a measure configuration list whether or not the function is active.", - "details": "You must create the configuration list before using this command.If index is not specified, the settings are stored to the next available index in the configuration list.", - "param_info": [ - { - "name": "listName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The measure function settings to save into the configuration list", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil|smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smumeasureconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.storefunc(listName, function)", - "smu.measure.configlist.storefunc(listName, function, index)" - ], - "overloads": [ - "smu.measure.configlist.storefunc(listName, function)" - ], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);", - "description": "Create a measure configuration list named MyMeasList.\n--- --Store the attributes for the DC Voltage settings in index\u00a01.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()", - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.source.configlist.storefunc()", - "webhelpfile": "91274.htm", - "signature": "smu.source.configlist.storefunc(ConfigListName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a source function into a source configuration list whether or not the function is active.", - "details": "The configuration list must be created before you send this function.", - "param_info": [ - { - "name": "ConfigListName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The function to save into the configuration list", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.storefunc(ConfigListName, function)", - "smu.source.configlist.storefunc(ConfigListName, function, index)" - ], - "overloads": [ - "smu.source.configlist.storefunc(ConfigListName, function)" - ], - "examples": [ - { - "example": "smu.source.configlist.create(\"sourcelist\");smu.source.configlist.storefunc(\"sourcelist\", smu.FUNC_DC_CURRENT);", - "description": "Create a configuration list named sourcelist.\n--- --Store the settings for the DC current source function into the configuration list in index 1.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.source.setattribute()", - "webhelpfile": "91275.htm", - "signature": "smu.source.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a source function whether or not the function is active.", - "details": "You can set the following parameters. The links in the list below link to the descriptions of the corresponding TSP command descriptions. The settings available for each parameter are the same as the settings for the TSP commands.The parameters you can set are:", - "param_info": [ - { - "name": "function", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcesetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The parameter to be set; see Details", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "" - }, - { - "name": "value", - "description": "The function or setting value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_RANGE, 0.007);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY, 0.35);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_LEVEL, 0.035);", - "description": "Sets the range, delay, and level settings for DC current, whether or not DC current is the active function.\n" - } - ], - "related_commands": [ - "smu.source.configlist.storefunc()", - "smu.source.getattribute()", - "" - ] - }, - { - "name": "smu.source.getattribute()", - "webhelpfile": "91276.htm", - "signature": "smu.source.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcegetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The setting of the attribute; refer to smu.source.setattribute() for the list of attributes", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "()" - } - ], - "usage": [ - "value = smu.source.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.getattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY));", - "description": "Retrieve the source delay setting for DC current.\n--- --Example return:\n--- --1.05e-07\n" - } - ], - "related_commands": [ - "smu.source.setattribute()" - ] - }, - { - "name": "smu.measure.setattribute()", - "webhelpfile": "91445.htm", - "signature": "smu.measure.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a measure function whether or not the function is active.", - "details": "The lists following the Example and Also See information show the attributes that are available for each function, with links to the descriptions of the corresponding TSP command descriptions. The options for each attribute are the same as the settings for the TSP commands.Aperture: smu.ATTR_DIGI_APERTURECount: smu.ATTR_DIGI_COUNTDisplay digits: smu.ATTR_DIGI_DIGITSRange: smu.ATTR_DIGI_RANGERelative offset enable: smu.ATTR_DIGI_REL_ENABLERelative offset level: smu.ATTR_DIGI_REL_LEVELSample rate: smu.ATTR_DIGI_SAMPLE_RATESense: smu.ATTR_DIGI_SENSEUnit: smu.ATTR_DIGI_UNITUser delay N (where N is 1 to 5): smu.ATTR_DIGI_USER_DELAY_NEnable math: smu.ATTR_DIGI_MATH_ENABLEb (offset) value: smu.ATTR_DIGI_MATH_MXB_BFm (scalar) value: smu.ATTR_DIGI_MATH_MXB_MFMath format: smu.ATTR_DIGI_MATH_FORMATPercent: smu.ATTR_DIGI_MATH_PERCENTLimit 1 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_1Limit 1 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_1Limit 1 enable: smu.ATTR_MEAS_LIMIT_ENABLE_1Limit 1 fail: smu.ATTR_MEAS_LIMIT_FAIL_1Limit 1 high value: smu.ATTR_MEAS_LIMIT_HIGH_1Limit 1 low value: smu.ATTR_MEAS_LIMIT_LOW_1Limit 2 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_2Limit 2 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_2Limit 2 enable: smu.ATTR_MEAS_LIMIT_ENABLE_2Limit 2 fail: smu.ATTR_MEAS_LIMIT_FAIL_2Limit 2 high value: smu.ATTR_MEAS_LIMIT_HIGH_2Limit 2 low value: smu.ATTR_MEAS_LIMIT_LOW_2Limit 1 audible: smu.ATTR_DIGI_LIMIT_AUDIBLE_1Limit 1 auto clear: smu.ATTR_DIGI_LIMIT_AUTO_CLEAR_1Limit 1 enable: smu.ATTR_DIGI_LIMIT_ENABLE_1Limit 1 fail: smu.ATTR_DIGI_LIMIT_FAIL_1Limit 1 high value: smu.ATTR_DIGI_LIMIT_HIGH_1Limit 1 low value: smu.ATTR_DIGI_LIMIT_LOW_1Limit 2 audible: smu.ATTR_DIGI_LIMIT_AUDIBLE_2Limit 2 auto clear: smu.ATTR_DIGI_LIMIT_AUTO_CLEAR_2Limit 2 enable: smu.ATTR_DIGI_LIMIT_ENABLE_2Limit 2 fail: smu.ATTR_DIGI_LIMIT_FAIL_2Limit 2 high value: smu.ATTR_DIGI_LIMIT_HIGH_2Limit 2 low value: smu.ATTR_DIGI_LIMIT_LOW_2", - "param_info": [ - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil|smu.FUNC_DIGITIZE_CURRENT nil|smu.FUNC_DIGITIZE_VOLTAGE nil", - "type": "smumeasuresetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to Details and the tables following the examples", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "" - }, - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_REL_LEVEL, 0.55);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_HIGH_1, 0.64);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_LOW_1, 0.32);smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);", - "description": "Configure the DC Voltage function settings for the relative offset level, limit 1 high value, and limit 1 low value whether or not DC Voltage is the active function.\n--- --Create a configuration list named MyMeasList.\n--- --Store the settings for the DC Voltage function in MyMeasList at index 1.\n" - } - ], - "related_commands": [ - "smu.measure.getattribute()" - ] - }, - { - "name": "smu.fastrangechange", - "webhelpfile": "91593.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute allows you to suppress checks that are normally done before range changes.", - "details": "When the Model 2461 changes ranges, it normally performs check for issues such as transients or overshoots to provide optimum measurements. When fast range change is set to on or persist, the instrument bypasses the normal checks when the range changes. Depending on your application, this can reduce the time required for measurements.", - "param_info": [ - { - "name": "state", - "description": "Select", - "enum": "smu.FASTRANGE_OFF nil|smu.FASTRANGE_ON nil|smu.FASTRANGE_PERSIST nil|smu.ON nil", - "type": "smufastrangechangestate", - "range": "" - } - ], - "usage": [ - "state = smu.fastrangechange", - "smu.fastrangechange = state" - ], - "overloads": [], - "examples": [ - { - "example": "-- Set fast range change on.;smu.fastrangechange = smu.FASTRANGE_ON;-- Reset the instrument.reset();-- Show that fast range change is set to off after the reset.;print(smu.fastrangechange);-- Set fast range change to persist through a reset.;smu.fastrangechange = smu.FASTRANGE_PERSIST;-- Reset the instrument.;reset()-- Show that fast range change is set to on after the reset.;print(smu.fastrangechange);", - "description": "This example demonstrates the difference between the smu.FASTRANGE_ON and smu.FASTRANGE_PERSIST options.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.priorityvoltage", - "webhelpfile": "91596.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute changes the method the instrument uses to select the power supply rail that drives the output.", - "details": "The Model 2461 uses three internal power supply rails to drive the output. The selection of which rail is determined by the limit range setting. To seamlessly supply the requested output voltage for the maximum current allowed, the instrument selects the highest power supply rail that supports the voltage for the current. Therefore, when the voltage priority is off, the selection of the rails is determined as shown in the following table.In cases where a test sequence switches frequently between low and high current ranges, there is a lot of switching between the rails, which can slow measurement speed.For tests that are low voltage, the switching is not necessary. In this case, you can turn voltage priority on to change the selection of the power supply rail to be based on the voltage range instead of the current range. When voltage priority is on, the selection of the rails is determined as shown in the following table.This allows low voltage tests to change from low to high current ranges with no rail switching. Depending on the test sequence, this can result in significant time savings.Turning voltage priority on if the test sequency uses more voltage range changes could cause more rail switching, which will result in a longer test times.", - "param_info": [ - { - "name": "state", - "description": "smu.OFF", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smupriorityvoltagestate", - "range": "" - } - ], - "usage": [ - "state = smu.priorityvoltage", - "smu.priorityvoltage = state" - ], - "overloads": [], - "examples": [ - { - "example": "smu.priorityvoltage = smu.ON;", - "description": "Use the voltage range to select the rail.\n" - } - ], - "related_commands": [ - "None" - ] - } - ] -} \ No newline at end of file diff --git a/data/2470.json b/data/2470.json deleted file mode 100644 index 0fc5efc..0000000 --- a/data/2470.json +++ /dev/null @@ -1,15010 +0,0 @@ -{ - "commands": [ - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double-beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - }, - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user-defined string catalog.", - "details": "The catalog provides access for user-defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user-defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key-value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user-defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user-defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user-defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "upgrade.previous()", - "webhelpfile": "14062.htm", - "signature": "upgrade.previous()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns to a previous version of the Model 2470 firmware.", - "details": "This function allows you to revert to an earlier version of the firmware.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument performs the upgrade. An error is returned if an upgrade file is not found.", - "param_info": [], - "usage": [ - "upgrade.previous()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "Upgrading the firmware", - "upgrade.unit()" - ] - }, - { - "name": "upgrade.unit()", - "webhelpfile": "14063.htm", - "signature": "upgrade.unit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function upgrades the Model 2470 firmware.", - "details": "When upgrade.unit() is used, the firmware is only loaded if the version of the firmware is newer than the existing version. If the version is older or at the same revision level, it is not upgraded.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument verifies that the file is a newer version. If the version is older or at the same revision level, it is not upgraded, although it does request a reboot. If it is a newer version, the instrument performs the upgrade. An error event message is returned if no upgrade file is found.", - "param_info": [], - "usage": [ - "upgrade.unit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "upgrade.previous()", - "Upgrading the firmware" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));\u00a0;\u00a0;\u00a0;tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP-enabled. The Model 2470 does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP-enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP-enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2470 sends an abort command to the remote device on connection. The Model 2470 also enables TSP prompts on the remote device and event management. The Model 2470 places remote errors and events from the TSP-enabled device in its own event queue and prefaces these events with Remote Error, followed by an event description. Do not manually change either the prompt functionality (localnode.prompts) or show events by changing localnode.showerrors or localnode.showevents on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP-enabled.\n" - } - ], - "related_commands": [ - "localnode.prompts", - "localnode.showevents", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP-Net session.\n--- --\u00a0\n--- --Close the session.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2470 decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the Model 2470 suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The Model 2470 places any remotely generated errors and events into its event queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear as:\n--- --KEITHLEY INSTRUMENTS,MODEL 2470,00000170,1.1.0s\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the Model 2470 pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the Model 2470 reads from a TSP-enabled remote instrument, the Model 2470 removes Test Script Processor (TSP\u00ae) prompts and places any errors or events it receives from the remote instrument into its own event queue. The Model 2470 prefaces events and errors from the remote device with Remote Error, followed by the event number and description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");\u00a0;repeat bytes = tspnet.readavailable(ID) until bytes > 0;\u00a0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that will create data.\n--- --\u00a0\n--- --Wait for data to be available.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands. ", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands will wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP-enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP-enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP-enabled instrument.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The Model 2470 sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma-delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "times = tspnet.tsp.rbtablecopy(testTspdevice,; \"testRemotebuffername.timestamps\", 1, 3);print(times);", - "description": "Copy the specified timestamps table for items 1 through 3, then display the table. Example output:\n--- --01/01/2015 10:10:10.0000013,01/01/2015 10:10:10.0000233,01/01/2015 10:10:10.0000576\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount | integer", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newpath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newpath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "18\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "15009.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts on a remote TSP-Link node. ", - "details": "This command is only applicable to TSP-Link systems. You can use this command to use the remote master node to run a script on the specified node. This function does not run test scripts on the master node; only on the subordinate node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x = 5\") to set x equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "related_commands": [ - "tsplink.group" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. ", - "details": "This function retrieves the value of a global variable from the run-time environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "related_commands": [ - "node[N].setglobal()" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2470 \n" - } - ], - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. ", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "related_commands": [ - "node[N].getglobal()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "15057.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex is set to less than 1 or if endIndex is more than the size of the index, 9.910000e+37 is returned for each value outside the allowed index and an event is generated.If overlapped commands use the specified reading buffers and the commands are not complete (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the readings have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data.The output of printbuffer() is affected by the data format selected by format.data. If you set format.data to format.REAL32 or format.REAL64, you have fewer options for buffer elements. With these formats, the only buffer elements available are readings, relativetimestamps, and extravalues. If you request a buffer element that is not permitted for the selected data format, the instrument returns 9.91e37.You can use the bufferVar attributes that are listed in the following table with the print buffer command. For example, if testData is the buffer, you can use testData.dates attribute to print the date of each reading in the testData buffer.You can use bufferVar.n to retrieve the number of readings in the specified reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "Name of first table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(200);format.data = format.ASCII;format.asciiprecision = 6;trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.readings, testData.units, testData.relativetimestamps);", - "description": "Reset the instrument.\n--- --Set the data format and ASCII precision.\n--- --Use trigger model SimpleLoop to create a 6-count loop with no delays that stores data in the reading buffer testBuffer.\n--- --Start the trigger model, wait for the commands to complete, and output the readings.\n--- --Use of testData.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, testBuffer.n equals 6.\n--- --Example of output data: \n--- --1.10458e-11, Amp DC, 0.00000e+00, 1.19908e-11, Amp DC, 1.01858e-01, 1.19908e-11, Amp DC, 2.03718e-01, 1.20325e-11, Amp DC, 3.05581e-01, 1.20603e-11, Amp DC, 4.07440e-01, 1.20325e-11, Amp DC, 5.09299e-01\n" - }, - { - "example": "for x = 1, testData.n do; printbuffer(x,x,testData, testData.units, testData.relativetimestamps);end;", - "description": "Using the same buffer created in Example 1, output the readings, units and relative timestamps on a separate line for each reading.\n--- --1.10458e-11, Amp DC, 0.00000e+00\n--- --1.19908e-11, Amp DC, 1.01858e-01\n--- --1.19908e-11, Amp DC, 2.03718e-01\n--- --1.20325e-11, Amp DC, 3.05581e-01\n--- --1.20603e-11, Amp DC, 4.07440e-01\n--- --1.20325e-11, Amp DC, 5.09299e-01\n" - } - ], - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP-Link node. ", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "2\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. ", - "details": "This command sets the TSP-Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP-Link instrument or tsplink.initialize() is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP-Link node for this instrument to number\u00a03.\n" - } - ], - "related_commands": [ - "tsplink.initialize() ", - "tsplink.state" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. ", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "related_commands": [ - "Triggering using TSP-Link trigger lines", - "tsplink.line[N].state", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP-Link online state. ", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.initialize() or tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "\"online\" | \"offline\"", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP-Link system. If it is online, the output is:\n--- --online\n" - } - ], - "related_commands": [ - "tsplink.initialize()", - "tsplink.node" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP-Link synchronization lines as a digital I/O port. ", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "related_commands": [ - "tsplink.line[N].state" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean | true | false", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that will be used the next time the timer is triggered.If you use the trigger timer with a trigger model, make sure the trigger timer delay is set so that the readings are paced correctly.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (8 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(8 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be >=\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};\u00a0;DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --\u00a0\n--- --Read the delay list on trigger timer\u00a03.\n--- --\u00a0\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event or is enabled as a timer or alarm.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - }, - { - "example": "reset();trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;\u00a0;trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY8);trigger.model.setblock(3, trigger.BLOCK_WAIT, trigger.EVENT_TIMER4);trigger.model.setblock(4, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 20, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the trigger timer 4 stimulus to off.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n--- --\u00a0\n--- --Clear the trigger model.\n--- --Set trigger model block 1 to clear the buffer.\n--- --Set trigger model block 2 to generate the notify 8 event.\n--- --Set trigger model block 3 to wait for the trigger timer 4 to occur.\n--- --Set trigger model block 4 to make a measurement and store it in default buffer 1.\n--- --Set trigger model block 5 to repeat the trigger model 20 times, starting at block 3.\n--- --Start the trigger model.\n--- --Wait until all commands are complete.\n--- --Print the number of entries in default buffer 1.\n--- --\u00a0\n--- --Output:\n--- --20\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified, the script is saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.If you set scriptVar to autoexec, the script is run when the instrument powers up. You must delete the existing autoexec script before saving the new one. Note that performing a system reset does not delete the autoexec script.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB flash drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "related_commands": [ - "Working with scripts" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "smu.measure.func", - "webhelpfile": "25622.htm", - "signature": "", - "command_return": "mFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_CURRENT\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the active measure function.", - "details": "Set this command to the type of measurement you want to make.Reading this command returns the measure function that is presently active.When you select a function, settings for other commands that are related to the function become active. For example, assume that:If you return to the current function, the math function returns to reciprocal. If you then switch from the current function to the voltage function, the math function returns to percent. All attributes that begin with smu.measure. are saved with the active measure function unless otherwise indicated in the command description.", - "param_info": [ - { - "name": "mFunction", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefuncmFunction", - "range": "" - } - ], - "usage": [ - "mFunction = smu.measure.func", - "smu.measure.func = mFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;print(smu.measure.math.format);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.math.format);", - "description": "Sets the instrument to measure voltage and set the math format to percent and enable the math functions.\n--- --Set the instrument to measure resistance and set the math format to reciprocal and enable the math functions.\n--- --Print the math format while the resistance measurement function is selected. The output is:\n--- --smu.MATH_RECIPROCAL\n--- --Change the function to voltage. Print the math format. The output is:\n--- --smu.MATH_PERCENT\n" - } - ], - "related_commands": [ - "Source and measure using TSP commands" - ] - }, - { - "name": "buffer.getstats()", - "webhelpfile": "25624.htm", - "signature": "buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "command_return": "statsVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns statistics from a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that was placed in the reading buffer.The instrument automatically updates reading buffer statistics as data is added to the reading buffer.When the reading buffer is configured to fill continuously and overwrite old data with new data, the buffer statistics include the data that was overwritten. To get statistics that do not include data that has been overwritten, define a large buffer size that will accommodate the number of readings you will make. The table returned from this function provides statistics at the time the function is called. Although the instrument continues to update the statistics, the table that is returned is not updated. To get fresh statistics, call this function again.The statsVar parameter contains the values described in the following table.If n equals zero (0), all other values are nil. If n equals 1, stddev is nil because the standard deviation of a sample size of 1 is undefined.Use the following command to get values from statsVar; a table with the following entries in it: n, min, max, mean, and stddev:Use the following commands to print these entries:", - "param_info": [ - { - "name": "statsVar", - "description": "A table that contains the entries for buffer statistics; see Details for information on the entries", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "absStartTime", - "description": "An integer that represents the absolute start time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absStartFractional", - "description": "An integer that represents the portion of the absolute start time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndTime", - "description": "An integer that represents the absolute end time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndFractional", - "description": "An integer that represents the portion of the absolute end time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relStartTime", - "description": "The start time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relEndTime", - "description": "The end time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "overloads": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 12, 0.001, defbuffer1);trigger.model.initiate();waitcomplete();\u00a0;stats = buffer.getstats(defbuffer1);print(stats);", - "description": "Reset the instrument.\n--- --Set up the SimpleLoop trigger-model template to make 12 readings with a 0.001\u00a0s delay. Readings are stored in defbuffer1.\n--- --Start the trigger model.\n--- --Assign the name stats to the table.\n--- --Get statistics for the default reading buffer named defbuffer1.\n--- --Example output:\n--- --[\"min\"]={[\"seconds\"]=1561123956, [\"fractionalseconds\"]=0.010184587, [\"timestamp\"]=1561123956, [\"reading\"]=8.4974199416e-05}, [\"mean\"]=0.000132948335, [\"stddev\"]=4.4270141937e-05, [\"max\"]={[\"seconds\"]=1561123955, [\"fractionalseconds\"]=0.833083981, [\"timestamp\"]=1561123955.8, [\"reading\"]=0.0002192359033}, [\"n\"]=12\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.model.abort()", - "webhelpfile": "25628.htm", - "signature": "trigger.model.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stops all trigger model commands on the instrument.", - "details": "When this command is received, the instrument stops the trigger model.", - "param_info": [ - { - "name": "trigger.model.abort()", - "description": "Terminates all commands related to the trigger model on the instrument.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.abort();", - "description": "Terminates all commands related to the trigger model on the instrument.\n" - } - ], - "related_commands": [ - "Effect of GPIB line events on Model 2470", - "Aborting the trigger model" - ] - }, - { - "name": "buffer.make()", - "webhelpfile": "25629.htm", - "signature": "buffer.make(bufferSize, style)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a user-defined reading buffer.", - "details": "You cannot assign user-defined reading buffers the name defbuffer1 or defbuffer2. In addition, the buffer name must not already exist as a global variable, a local variable, table, or array.If you create a reading buffer that has the same name as an existing user-defined buffer, the existing buffer is overwritten by the new buffer. Any data in the existing buffer is lost.When you create a reading buffer, it becomes the active buffer. If you create two reading buffers, the last one you create becomes the active buffer.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.The default fill mode of a user-defined buffer is once. You can change it to continuous later.Once the buffer style is selected, it cannot be changed.Once you store the first reading in a compact buffer, you cannot change certain measurement settings, including range, display digits, and units; you must clear the buffer first.Not all remote commands are compatible with the compact, writable, and full writable buffer styles. Check the Details section of the command descriptions before using them with any of these buffer styles.Writable reading buffers are used to bring external data into the instrument. You cannot assign them to collect data from the instrument.You can change the buffer capacity for an existing buffer through the front panel or by using the bufferVar.capacity command.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferSize", - "description": "The maximum number of readings that can be stored in bufferVar; minimum is\u00a010; 0 to maximize buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "style", - "description": "The type of reading buffer to create", - "enum": "buffer.STYLE_COMPACT nil|buffer.STYLE_STANDARD nil|buffer.STYLE_FULL nil|buffer.STYLE_WRITABLE nil|buffer.STYLE_WRITABLE_FULL nil", - "type": "buffermakestyle", - "range": "" - } - ], - "usage": [ - "bufferVar = buffer.make(bufferSize)", - "bufferVar = buffer.make(bufferSize, style)" - ], - "overloads": [ - "bufferVar = buffer.make(bufferSize)" - ], - "examples": [ - { - "example": "capTest2\u00a0= buffer.make(200, buffer.STYLE_FULL);", - "description": "Creates a 200-element reading buffer that stores readings with full accuracy named capTest2.\n" - } - ], - "related_commands": [ - "bufferVar.capacity", - "bufferVar.fillmode", - "buffer.write.format()", - "buffer.write.reading()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "25630.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the specified reading buffer.", - "details": "You can call this command to return the number of readings stored in the specified reading buffer.You can use the bufferVar.n attribute in other commands. For example, to print all the readings in a buffer, use the following command:Where bufferVar is the name of the buffer to use.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the reading buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(100);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.n);print(defbuffer1.n);print(defbuffer2.n);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the number of readings in testData.\n--- --Output:\n--- --3\n--- --Print the number of readings in defbuffer1.\n--- --Example output:\n--- --0\n--- --Print the number of readings in defbuffer2.\n--- --Example output:\n--- --0\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "timer.gettime()", - "webhelpfile": "25635.htm", - "signature": "timer.gettime()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function measures the elapsed time since the timer was last cleared.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.cleartime()" - ] - }, - { - "name": "timer.cleartime()", - "webhelpfile": "25636.htm", - "signature": "timer.cleartime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "dataqueue.clear()dataqueue.add(35)timer.cleartime()delay(0.5)dt = timer.gettime()print(\"Delay time was \" .. dt)print(dataqueue.next())", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.cleartime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.gettime()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "25637.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending command triggers.", - "details": "A command trigger indicates if a trigger event has been detected over a command interface since the last trigger.wait() command was sent. Command triggers are generated by:trigger.clear() clears the command triggers and discards the history of trigger events.", - "param_info": [ - { - "name": "*TRGprint(trigger.wait(1))trigger.clear()print(trigger.wait(1))", - "description": "Generate a trigger event.Check if there are any pending trigger events. Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "*TRG;print(trigger.wait(1));trigger.clear();print(trigger.wait(1));", - "description": "Generate a trigger event.\n--- --Check if there are any pending trigger events. \n--- --Output: true\n--- --Clear any pending command triggers.\n--- --Check if there are any pending trigger events.\n--- --Output: false\n" - } - ], - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "25639.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "A trigger was detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "bufferVar.formattedreadings", - "webhelpfile": "25640.htm", - "signature": "bufferVar.formattedreadings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the stored readings shown as numbers with units and prefixes.", - "details": "This read-only attribute is an array that contains the stored readings. The readings are shown as numbers with prefixes before the units symbol.", - "param_info": [ - { - "name": "reading", - "description": "Buffer reading formatted with numbers and prefixes with units for element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.formattedreadings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.formattedreadings[1]);printbuffer(1, testData.n, testData.formattedreadings);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading.\n--- --Example output:\n--- --+00.0028 nA\n--- --Print all readings in the reading buffer.\n--- --Example output:\n--- --+00.0028 nA, +00.0039 nA, +00.0040 nA\n--- --\u00a0\n" - } - ], - "related_commands": [ - "bufferVar.readings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.units", - "webhelpfile": "25641.htm", - "signature": "bufferVar.units[N]", - "command_return": "readingUnit", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "details": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "param_info": [ - { - "name": "readingUnit", - "description": "Volt DC", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingUnit = bufferVar.units[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);testData.fillmode = buffer.FILL_CONTINUOUS;smu.measure.func = smu.FUNC_DC_CURRENT;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the buffer to fill continuously.\n--- --Set the measure function to current.\n--- --Make three readings.\n--- --Print the units for the readings.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the measure function to voltage.\n--- --Make three readings.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.saveappend()", - "webhelpfile": "25642.htm", - "signature": "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function appends data from the reading buffer to a file on the USB flash drive.", - "details": "If the file you specify does not exist on the USB flash drive, this command creates the file.For options that save more than one item of time information, each item is comma-delimited. For example, the default format is date, time, and fractional seconds for each reading.The file extension .csv is appended to the file name if necessary. Any file extension other than .csv generates an error.The index column entry in the .csv file starts at 1 for each append operation.Examples of valid destination file names:Invalid destination file name examples:\u2014 The period is not followed by csv.\u2014 The only allowed extension is .csv. If .csv is not assigned, it is automatically added.", - "param_info": [ - { - "name": "bufferVar", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Indicates how date and time information from the buffer is saved in the file on the USB flash drive; the options are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersaveappendtimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)", - "buffer.saveappend(bufferVar, fileName, timeFormat, start, end)" - ], - "overloads": [ - "buffer.saveappend(bufferVar, fileName)", - "buffer.saveappend(bufferVar, fileName, timeFormat)" - ], - "examples": [ - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myData.csv\");", - "description": "Append reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Append readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash\u00a0drive.\n" - }, - { - "example": "reset();if file.usbdriveexists() == 1 then; testDir = \"TestData11\";-- Create a directory on the USB drive for the data.; file.mkdir(testDir);-- Build the full file and path.; fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";-- Open the file where the data will be stored.; fileNumber = file.open(fileName, file.MODE_WRITE);-- Write the string data to a file.; file.write(fileNumber, \"Tested to Company Standard ABC.101\\n\");-- Write the header separator to a file.; file.write(fileNumber, \"====================================================================\\n\");-- Write the string data to a file.; file.write(fileNumber, \"\\t1. Connect HI/LO to respective DUT terminals.\\n\"); file.write(fileNumber, \"\\t2. Set power supply to 5 VDC @ 1 A.\\n\"); file.write(fileNumber, \"\\t3. Wait 30 minutes.\\n\"); file.write(fileNumber, \"\\t4. Capture 100 readings and analyze data.\\n\\n\\n\");-- Write buffering data to a file.; file.flush(fileNumber);-- Close the data file.; file.close(fileNumber);end;-- Fix the range to 10 V.;smu.measure.range = 10.0;-- Set the measurement count to 100.;smu.measure.count = 100;-- Set up reading buffers.;-- Ensure the default measurement buffer size matches the count.;defbuffer1.capacity = smu.measure.count;smu.measure.read();buffer.saveappend(defbuffer1, fileName);", - "description": "Write string data to a file with information about a test file.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.save()" - ] - }, - { - "name": "smu.measure.math.enable", - "webhelpfile": "25644.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables math operations on measurements for the selected measurement function.", - "details": "When this command is set to on, the math operation specified by the math format command is performed before completing a measurement.", - "param_info": [ - { - "name": "value", - "description": "The math enable setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasuremathenablevalue", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathenablefunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.enable", - "smu.measure.math.enable = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_ENABLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.enable = smu.ON;", - "description": "When voltage measurements are made, the math format is enabled and set to percent.\n" - } - ], - "related_commands": [ - "smu.measure.math.format" - ] - }, - { - "name": "smu.measure.rel.acquire()", - "webhelpfile": "25645.htm", - "signature": "smu.measure.rel.acquire()", - "command_return": "relativeValue", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function acquires a measurement and stores it as the relative offset value.", - "details": "This command triggers the instrument to make a new measurement for the selected function. This measurement is then stored as the new relative offset level.When you send this command, the instrument does not apply any math, limit test, or filter settings to the measurement, even if they are set. It is a measurement that is made as if these settings are disabled.If an error event occurs during the measurement, nil is returned and the relative offset level remains at the last valid setting.You must change to the function for which you want to acquire a value before sending this command.The instrument must have relative offset enabled to use the acquired relative offset value.After executing this command, you can use the smu.measure.rel.level attribute to see the last relative level value that was acquired or that was set.", - "param_info": [ - { - "name": "relativeValue", - "description": "The internal measurement acquired for the relative offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "relativeValue = smu.measure.rel.acquire()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.enable", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.limit[Y].autoclear", - "webhelpfile": "25682.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the test result for limit Y should be cleared automatically or not.", - "details": "When auto clear is set to on, limit conditions are cleared automatically after each measurement. If you are making a series of measurements, the instrument shows the limit test result of the last measurement for the pass or fail indication for the limit.If you want to know if any of a series of measurements failed the limit, set the auto clear setting to off. When this is set to off, a failed indication is not cleared automatically. It remains set until it is cleared with the clear command.The auto clear setting affects both the high and low limits.", - "param_info": [ - { - "name": "value", - "description": "The auto clear setting", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitautoclearvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitautoclearfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].autoclear = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[1].autoclear = smu.ON;", - "description": "Turns on autoclear for limit 1 when measuring DC current.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].clear()" - ] - }, - { - "name": "smu.measure.limit[Y].clear()", - "webhelpfile": "25683.htm", - "signature": "smu.measure.limit[Y].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the results of the limit test defined by Y for the selected measurement function.", - "details": "Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared.To avoid the need to manually clear the test results for a limit, turn the auto clear option on.", - "param_info": [ - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.limit[Y].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.limit[2].clear();", - "description": "Clears the test result for the high and low limit 2 for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear" - ] - }, - { - "name": "smu.measure.limit[Y].fail", - "webhelpfile": "25684.htm", - "signature": "", - "command_return": "result", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute queries the results of a limit test.", - "details": "This command queries the result of a limit test for the selected measurement function.The response message indicates if the limit test passed or how it failed (on the high or low limit).If autoclear is set to off, reading the results of a limit test does not clear the fail indication of the test. To clear a failure, send the clear command. To automatically clear the results, set auto clear on.If auto clear is set to on and you are making a series of measurements, the last measurement limit determines the fail indication for the limit. If auto clear is turned off, the results return a test fail if any of one of the readings failed.To use this attribute, you must set the limit state to on.If the readings are stored in a reading buffer, you can use the bufferVar.statuses command to see the results.This example enables limits 1 and 2 for voltage, measurements. Limit 1 is checking for readings to be between 3 and 5 V, while limit\u00a02 is checking for the readings to be between 1 and 7 V. The auto clear feature is disabled, so if any reading is outside these limits, the corresponding fail is 1. Therefore, if any one of the fails is 1, analyze the reading buffer data to find out which reading failed the limits.", - "param_info": [ - { - "name": "result", - "description": "The results of the limit test for limit Y", - "enum": "smu.FAIL_NONE nil|smu.FAIL_HIGH nil|smu.FAIL_LOW nil|smu.FAIL_BOTH nil", - "type": "smumeasurelimitfailresult", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitfailfunction", - "range": "" - } - ], - "usage": [ - "result = smu.measure.limit[Y].fail", - "result = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_FAIL_Y)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();-- set the instrument source current;smu.source.func = smu.FUNC_DC_CURRENT;-- set the instrument to measure voltage;smu.measure.func = smu.FUNC_DC_VOLTAGE;-- set the range to 10 V;smu.measure.range = 10;-- set the nplc to 0.1;smu.measure.nplc = 0.1;-- disable auto clearing for limit 1;smu.measure.limit[1].autoclear = smu.OFF;-- set high limit on 1 to fail if reading exceeds 5 V;smu.measure.limit[1].high.value = 5;-- set low limit on 1 to fail if reading is less than 3 V;smu.measure.limit[1].low.value = 3;--- set the beeper to sound if the reading exceeds the limits for limit 1;smu.measure.limit[1].audible = smu.AUDIBLE_FAIL;-- enable limit 1 checking for voltage measurements;smu.measure.limit[1].enable = smu.ON;-- disable auto clearing for limit 2;smu.measure.limit[2].autoclear = smu.OFF;-- set high limit on 2 to fail if reading exceeds 7 V;smu.measure.limit[2].high.value = 7;-- set low limit on 2 to fail if reading is less than 1 V;smu.measure.limit[2].low.value = 1;-- enable limit 2 checking for voltage measurements;smu.measure.limit[2].enable = smu.ON;-- set the measure count to 50;smu.measure.count = 50;-- create a reading buffer that can store 100 readings;LimitBuffer = buffer.make(100);-- make 50 readings and store them in LimitBuffer;smu.measure.read(LimitBuffer);-- Check if any of the 50 readings were outside of the limits;print(\"limit 1 results = \" .. smu.measure.limit[1].fail);print(\"limit 2 results = \" .. smu.measure.limit[2].fail);-- clear limit 1 conditions;smu.measure.limit[1].clear();-- clear limit 2 conditions;smu.measure.limit[2].clear();", - "description": "Example output that shows all readings are within limit values (all readings between 3 V and 5 V):\n--- --limit 1 results = smu.FAIL_NONE\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 high values (a 6\u00a0V reading would cause this condition or a reading greater than 5 V but less than 7 V):\n--- --limit 1 results = smu.FAIL_HIGH\n--- --limit 2 results = smu.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 and 2 low values (a 0.5 V reading would cause this condition or a reading less than 1\u00a0V):\n--- --limit 1 results = smu.FAIL_LOW\n--- --limit 2 results = smu.FAIL_LOW\n" - } - ], - "related_commands": [ - "bufferVar.statuses", - "Limit testing and binning", - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].high.value", - "webhelpfile": "25685.htm", - "signature": "", - "command_return": "highLimit", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the upper limit for a limit test.", - "details": "This command sets the high limit for the limit Y test for the selected measurement function. When limit Y testing is enabled, the instrument generates a fail indication when the measurement value is more than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "highLimit", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)", - "enum": "", - "type": "number", - "range": "(-9.99999e+11 to +9.99999e+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimithighvaluefunction", - "range": "" - } - ], - "usage": [ - "highLimit = smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].high.value = highLimit", - "highLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_HIGH_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_HIGH_Y, highLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "highLimit;", - "description": "The value of the high limit (-9.99999e+11 to +9.99999e+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.limit[Y].low.value", - "webhelpfile": "25686.htm", - "signature": "", - "command_return": "lowLimit", - "type": "Attribute (RW)", - "default_value": "-1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the lower limit for limit tests.", - "details": "This command sets the lower limit for the limit Y test for the selected measure function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.See the example in smu.measure.limit[Y].fail.", - "param_info": [ - { - "name": "lowLimit", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)", - "enum": "", - "type": "number", - "range": "(-9.99999E+11 to 9.99999E+11)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitlowvaluefunction", - "range": "" - } - ], - "usage": [ - "lowLimit = smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].low.value = lowLimit", - "lowLimit = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_LOW_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_LOW_Y, lowLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "lowLimit;", - "description": "The low limit value of limit Y (-9.99999E+11 to 9.99999E+11)\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": "smu.measure.math.format", - "webhelpfile": "25687.htm", - "signature": "", - "command_return": "operation", - "type": "Attribute (RW)", - "default_value": "smu.MATH_PERCENT\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which math operation is performed on measurements when math operations are enabled.", - "details": "This specifies which math operation is performed on measurements for the selected measurement function.You can choose one of the following math operations:Math calculations are applied to the input signal after relative offset and before limit tests.", - "param_info": [ - { - "name": "operation", - "description": "Math operation to be performed on measurements", - "enum": "smu.MATH_MXB nil|smu.MATH_PERCENT nil|smu.MATH_RECIPROCAL nil", - "type": "smumeasuremathformatoperation", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathformatfunction", - "range": "" - } - ], - "usage": [ - "operation = smu.measure.math.format", - "smu.measure.math.format = operation", - "operation = smu.measure.getattribute(function, ATTR_MEAS_MATH_FORMAT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_FORMAT, operation)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_RECIPROCAL;smu.measure.math.enable = smu.ON;", - "description": "Enables the reciprocal math operation on voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.mfactor", - "smu.measure.math.percent" - ] - }, - { - "name": "smu.measure.read()", - "webhelpfile": "25688.htm", - "signature": "smu.measure.read(bufferName)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes measurements, places them in a reading buffer, and returns the last reading.", - "details": "This function makes a measurement using the present function setting, stores the reading in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed. You can also use the trigger model Simple Loop.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is defined, it defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading = smu.measure.read()", - "reading = smu.measure.read(bufferName)" - ], - "overloads": [ - "reading = smu.measure.read()" - ], - "examples": [ - { - "example": "voltMeasBuffer = buffer.make(10000);smu.measure.func = smu.FUNC_DC_VOLTAGE;print(smu.measure.read(voltMeasBuffer));", - "description": "Create a buffer named voltMeasBuffer. Set the instrument to measure voltage.\n--- --Make a measurement that is stored in the voltMeasBuffer and is also printed.\n" - } - ], - "related_commands": [ - "buffer.make()", - "smu.measure.count", - "smu.measure.unit", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.measure.configlist.create()", - "webhelpfile": "25691.htm", - "signature": "smu.measure.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty measure configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");", - "description": "Create a measure configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.catalog()", - "smu.measure.configlist.delete()", - "smu.measure.configlist.query()", - "smu.measure.configlist.recall()", - "smu.measure.configlist.size()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.store()", - "webhelpfile": "25693.htm", - "signature": "smu.source.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active source settings into the named configuration list.", - "details": "Use this command to store the active source settings to a configuration index in a configuration list. If the index is defined, the configuration list is stored in that index. If the index is not defined, the configuration index is appended to the end of the list. If a configuration index already exists for the specified index, the new configuration overwrites the existing configuration index.Refer to Settings stored in a source configuration index for information about the settings this command stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.store(listName)", - "smu.source.configlist.store(listName, index)" - ], - "overloads": [ - "smu.source.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.store(\"MyConfigList\");", - "description": "Store the active settings of the instrument to the source configuration list MyConfigList. Settings are saved at the end of the list since no index parameter is specified.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.configlist.catalog()", - "webhelpfile": "25695.htm", - "signature": "smu.source.configlist.catalog()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one source configuration list.", - "details": "You can use this command to retrieve the names of source configuration lists that are stored in the instrument.This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no source configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "print(smu.source.configlist.catalog())", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.catalog());", - "description": "Request the name of one source configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.create()", - "webhelpfile": "25696.htm", - "signature": "smu.source.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty source configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. If you want to save a configuration list through a power cycle, create a configuration script to save instrument settings, including any defined configuration lists.Configuration list names must be unique. For example, the name of a source configuration list cannot be the same as the name of a measure configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;\u00a0;smu.source.configlist.create(\"MyScrList\");\u00a0;print(smu.source.configlist.catalog());\u00a0;print(smu.source.configlist.catalog());\u00a0;\u00a0;\u00a0;smu.source.configlist.store(\"MyScrList\");smu.source.configlist.store(\"MyScrList\");print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Create a source configuration list named MyScrLst.\n--- --Print the name of one configuration list stored in volatile memory.\n--- --Output:\n--- --MyScrList\n--- --Print the name of one configuration list.\n--- --Output:\n--- --nil\n--- --Nil indicates that no more configuration lists are stored.\n--- --Store a configuration index in MyScrList.\n--- --Store a configuration index in MyScrList.\n--- --Print the number of configuration indexes in MyScrList.\n--- --Output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.store()" - ] - }, - { - "name": "smu.source.configlist.delete()", - "webhelpfile": "25697.htm", - "signature": "smu.source.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a source configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.delete(listName)", - "smu.source.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.source.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.source.configlist.delete(\"mySourceList\");", - "description": "Deletes a configuration list named mySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.query()", - "webhelpfile": "25698.htm", - "signature": "smu.source.configlist.query(listName, index, fieldSeparator)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command can only return data for one configuration index. To get data for additional configuration indexes, resend the command and specify different configuration indexes. Refer to Settings stored in a source configuration list for a complete list of source settings that the instrument stores in a source configuration list.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list; the default is the first index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.query(listName, index)", - "smu.source.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "smu.source.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(smu.source.configlist.query(\"MyScrList\", 2));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "smu.source.configlist.size()", - "webhelpfile": "25700.htm", - "signature": "smu.source.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of configuration indexes in a source configuration list.", - "details": "The size of the list is equal to the number of configuration indexes in a configuration list.", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total quantity of indexes stored in the specified source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.source.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.configlist.size(\"MyScrList\"));", - "description": "Determine the number of configuration indexes in a source configuration list named MyScrList.\n--- --Example output:\n--- --2\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "eventlog.save()", - "webhelpfile": "25702.htm", - "signature": "eventlog.save(filename, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the event log to a file on a USB flash drive.", - "details": "This command saves all event log entries to a USB flash drive.If you do not define an event type, the instrument saves all event log entries.The extension .csv is automatically added to the file name.", - "param_info": [ - { - "name": "filename", - "description": "A string that represents the name of the file to be saved", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsaveeventType", - "range": "" - } - ], - "usage": [ - "eventlog.save(filename)", - "eventlog.save(filename, eventType)" - ], - "overloads": [ - "eventlog.save(filename)" - ], - "examples": [ - { - "example": "eventlog.save(\"/usb1/WarningsApril\", eventlog.SEV_WARN);", - "description": "Save warning messages to a .csv file on a USB flash drive.\n" - } - ], - "related_commands": [ - "eventlog.next()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "25706.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This command allows you to change or view how many readings a buffer can store. Changing the size of a buffer will cause any existing data in the buffer to be lost.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store; set to 0 to maximize the buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity", - "bufferVar.capacity = bufferCapacity" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(500);capTest = buffer.make(300);bufferCapacity = capTest.capacity;\u00a0;print(bufferCapacity);\u00a0;\u00a0;print(testData.capacity);\u00a0;\u00a0;testData.capacity = 600;print(testData.capacity);print(defbuffer1.capacity);", - "description": "Create two user-defined reading buffers: testData and capTest.\n--- --\u00a0\n--- --Create a variable called bufferCapacity to hold the capacity of the capTest buffer.\n--- --Print bufferCapacity.\n--- --Output:\n--- --300\n--- --Print the capacity of testData.\n--- --Output:\n--- --500\n--- --Changes the capacity of testData to 600.\n--- --Print the capacity of testData.\n--- --Output:\n--- --600\n--- --Print the capacity of the default buffer defbuffer1.\n--- --Output:\n--- --10000\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourceunits", - "webhelpfile": "25707.htm", - "signature": "bufferVar.sourceunits[N]", - "command_return": "readingUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of measure of the source.", - "details": "The attribute is an array (a Lua table) of strings indicating the units of measure at the time of the reading.", - "param_info": [ - { - "name": "readingUnits", - "description": "The units of measure of the source", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "readingUnits = bufferVar.sourceunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;testData.fillmode = buffer.FILL_CONTINUOUS;trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_CURRENT;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);trigger.model.load(\"SimpleLoop\", 3, 0, testData);smu.source.func = smu.FUNC_DC_VOLTAGE;trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.sourceunits);smu.source.output = smu.OFF;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source output to ON.\n--- --Set the buffer to fill continuously.\n--- --Set the source function to current.\n--- --Take three readings.\n--- --Print the units for the first three readings in the buffer.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the source function to voltage.\n--- --Take three readings.\n--- --Print the units for the readings in the buffer.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "bufferVar.sourceunits", - "bufferVar.sourcevalues", - "bufferVar.statuses" - ] - }, - { - "name": "bufferVar.relativetimestamps", - "webhelpfile": "25712.htm", - "signature": "bufferVar.relativetimestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamps, in seconds, when each reading occurred, relative to the timestamp of the first entry in the reading buffer.", - "details": "This read-only attribute is an array of timestamps, in seconds, of when each reading occurred relative to the timestamp of the first entry in the reading buffer. These timestamps are equal to the time that has lapsed for each reading since the first reading was stored in the buffer. Therefore, the relative timestamp for the first entry number in the reading buffer equals 0.", - "param_info": [ - { - "name": "timestamp", - "description": "The timestamp, in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timestamp = bufferVar.relativetimestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.relativetimestamps[1]);printbuffer(1, 3, testData.relativetimestamps);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --\u00a0\n--- --Print the relative timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0\n--- --Print the relative timestamp for the reading 1 through 3 in the buffer.\n--- --Example output:\n--- --0, 0.383541, 0.772005\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.seconds", - "webhelpfile": "25713.htm", - "signature": "bufferVar.seconds[N]", - "command_return": "nonFracSeconds", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp of a reading in seconds, in UTC format.", - "details": "This attribute contains the nonfractional seconds portion of the timestamp when the reading was stored in Coordinated Universal Time (UTC) format.The nonfractional seconds portion of the timestamp gives the lowest resolution down to 1 second. To access additional resolution of a timestamp, see bufferVar.fractionalseconds.", - "param_info": [ - { - "name": "nonFracSeconds", - "description": "The nonfractional seconds portion of the timestamp when the reading was stored", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "nonFracSeconds = bufferVar.seconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 6, testData.seconds);", - "description": "Create a reading buffer named testData, configure the instrument to make six measurements, and store the readings in the buffer.\n--- --Print the seconds portion for readings 1 to 6 in testData. \n--- --Example output:\n--- --1362261492, 1362261492, 1362261493, 1362261493, 1362261493, 1362261494\n" - } - ], - "related_commands": [ - "bufferVar.fractionalseconds", - "bufferVar.relativetimestamps" - ] - }, - { - "name": "bufferVar.times", - "webhelpfile": "25715.htm", - "signature": "bufferVar.times[N]", - "command_return": "readingTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the time when the instrument made the reading.", - "details": "", - "param_info": [ - { - "name": "readingTime", - "description": "The time of the reading in hours, minutes, and seconds", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTime = bufferVar.times[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.times[1]);printbuffer(1, 3, testData.times);", - "description": "This example creates a reading buffer named testData and makes three measurements.\n--- --The print() command outputs the time of the first reading. \n--- --Output:\n--- --23:09:43\n--- --The printbuffer() command outputs the time of readings 1 to 3 in the reading buffer. \n--- --Output:\n--- --23:09:43, 23:09:43, 23:09:43\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "25716.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "readingTimestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "This attribute contains the timestamps (date, hours, minutes, seconds, and fractional seconds) of readings stored in the reading buffer.", - "param_info": [ - { - "name": "readingTimestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "string[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTimestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.timestamps[1]);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Output:\n--- --03/01/2018 14:46:07.714614838\n" - }, - { - "example": "for x = 1, 3 do printbuffer(x, x, testData.timestamps) end;", - "description": "For the buffer created in Example 1, print the timestamps for the readings.\n--- --Output:\n--- --03/01/2018 14:46:07.71461483803/01/2018 14:46:08.10046883803/01/2018 14:46:08.487631838\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.readingformat", - "webhelpfile": "25719.htm", - "signature": "", - "command_return": "format", - "type": "Attribute (RW)", - "default_value": "display.FORMAT_PREFIX\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the format that is used to display measurement readings on the front-panel display of the instrument.", - "details": "This setting persists through reset() and power cycles.When Prefix is selected, prefixes are added to the units symbol, such as k (kilo) or m (milli). When Exponent is selected, exponents are used instead of prefixes. When the prefix option is selected, very large or very small numbers may be displayed with exponents.", - "param_info": [ - { - "name": "format", - "description": "Use exponent format", - "enum": "display.FORMAT_EXPONENT nil|display.FORMAT_PREFIX nil", - "type": "displayreadingformatformat", - "range": "" - } - ], - "usage": [ - "format = display.readingformat", - "display.readingformat = format" - ], - "overloads": [], - "examples": [ - { - "example": "display.readingformat = display.FORMAT_EXPONENT;", - "description": "Change front-panel display to show readings in exponential format.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "25722.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function defines the text that is displayed on the front-panel USER swipe screen.", - "details": "This command defines text messages for the USER swipe screen.If you enter too many characters, the instrument displays a warning event and shortens the message to fit.When the instrument is reset, the user test is removed and the USER swipe screen is hidden until another message is defined.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "displayArea", - "description": "display.TEXT1 display.TEXT2", - "enum": "display.TEXT1 nil|display.TEXT2 nil", - "type": "displaysettextdisplayArea", - "range": "" - }, - { - "name": "text", - "description": "String that contains the message for the top line of the USER swipe screen (up to 20 characters)", - "enum": "", - "type": "string", - "range": "(up to 20 characters)" - } - ], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"A122 \\185 A123\");display.settext(display.TEXT2, \"Results in \\018\");", - "description": "Clear the USER swipe screen.\n--- --Display the USER swipe screen.\n--- --Set the first line to read \"A122 \u0394 A123\" and the second line to display \"\"Results in \u03a9\":\n--- --\n" - } - ], - "related_commands": [ - "display.clear()", - "display.changescreen()" - ] - }, - { - "name": "file.mkdir()", - "webhelpfile": "25723.htm", - "signature": "file.mkdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a directory at the specified path on the USB flash drive.", - "details": "The directory path must be absolute. The name of the directory must not already exist on the flash drive.", - "param_info": [ - { - "name": "path", - "description": "A string that contains the path of the directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.mkdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "file.mkdir(\"TestData\");", - "description": "Create a new directory named TestData.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.open()", - "webhelpfile": "25724.htm", - "signature": "file.open(fileName, accessType)", - "command_return": "fileNumber", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file on the USB flash drive for later reference.", - "details": "The path to the file to open must be absolute.The root folder of the USB flash drive has the following absolute path:", - "param_info": [ - { - "name": "fileNumber", - "description": "A number identifying the open file that you use with other file commands to write, read, flush, or close the file after opening", - "enum": "", - "type": "file_object", - "range": "" - }, - { - "name": "fileName", - "description": "A string that contains the file name to open, including the full path of file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "accessType", - "description": "The type of action to do", - "enum": "file.MODE_APPEND nil|file.MODE_READ nil|file.MODE_WRITE nil", - "type": "fileopenaccessType", - "range": "" - } - ], - "usage": [ - "fileNumber = file.open(fileName, accessType)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.ipconfig()", - "webhelpfile": "25725.htm", - "signature": "lan.ipconfig()", - "command_return": "method, ipV4Address, subnetMask, gateway", - "type": "Function", - "default_value": "lan.MODE_AUTO\n", - "tsp_link": "No\n", - "description": "This function specifies the LAN configuration for the instrument.", - "details": "This command specifies how the LAN IP address and other LAN settings are assigned. If automatic configuration is selected, the instrument automatically determines the LAN information. When method is automatic, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, an error occurs.If manual is selected, you must define the IP address. You can also assign a subnet mask, and default gateway. The IP address, subnet mask, and default gateway must be formatted in four groups of numbers, each separated by a decimal. If you do not specify a subnet mask or default gateway, the previous settings are used.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.MODE_AUTO nil|lan.MODE_MANUAL nil", - "type": "lanipconfigmethod", - "range": "" - }, - { - "name": "ipV4Address", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "subnetMask", - "description": "The LAN subnet mask; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "gateway", - "description": "The LAN default gateway; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "method, ipV4Address, subnetMask, gateway = lan.ipconfig()", - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "overloads": [ - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "examples": [ - { - "example": "lan.ipconfig(lan.MODE_AUTO);print(lan.ipconfig());lan.ipconfig(lan.MODE_MANUAL, \"192.168.0.7\", \"255.255.240.0\", \"192.168.0.3\");print(lan.ipconfig());", - "description": "Set the IP configuration method to automatic. Request the IP configuration. Example output:\n--- --lan.MODE_AUTO 134.63.78.136\u00a0\u00a0 255.255.254.0\u00a0\u00a0 134.63.78.1\n--- --Set the IP configuration method to manual. Request the IP configuration. Output:\n--- --lan.MODE_MANUAL 192.168.0.7\u00a0\u00a0\u00a0 255.255.240.0\u00a0 192.168.0.3\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.settime()", - "webhelpfile": "25726.htm", - "signature": "localnode.settime(year, month, day, hour, minute, second)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the date and time of the instrument.", - "details": "Internally, the instrument bases time in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).When called without a parameter (the first form), the function returns the current time.", - "param_info": [ - { - "name": "year", - "description": "Year; must be more than 1970", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "month", - "description": "Month (1 to 12)", - "enum": "", - "type": "number", - "range": "(1 to 12)" - }, - { - "name": "day", - "description": "Day (1 to 31)", - "enum": "", - "type": "number", - "range": "(1 to 31)" - }, - { - "name": "hour", - "description": "Hour in 24-hour time format (0 to 23)", - "enum": "", - "type": "number", - "range": "(0 to 23)" - }, - { - "name": "minute", - "description": "Minute (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - }, - { - "name": "second", - "description": "Second (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - } - ], - "usage": [ - "localnode.settime()", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "overloads": [ - "localnode.settime()", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "examples": [ - { - "example": "localnode.settime(2017, 12, 5, 15, 48, 20);print(localnode.settime());", - "description": "Sets the date and time to December 5, 2017 at 3:48:20\u00a0pm and verifies the time.\n--- --Output:\n--- --Tue Dec 5 15:48:20 2017\n" - }, - { - "example": "systemTime = os.time({year = 2018,; month = 3,; day = 31,; hour = 14,; min = 25});localnode.settime(systemTime);print(os.date('%c', gettime()));", - "description": "Sets the date and time to Mar 31, 2018 at 2:25\u00a0pm.\n--- --Output:\n--- --Sat Mar 31 14:25:00 2018\n" - } - ], - "related_commands": [ - "localnode.gettime()" - ] - }, - { - "name": "smu.interlock.tripped", - "webhelpfile": "25729.htm", - "signature": "", - "command_return": "interlockStatus", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates that the interlock has been tripped.", - "details": "This command gives you the status of the interlock. When the safety interlock signal is asserted, all voltage ranges of the instrument are available. However, when the safety interlock signal is not asserted, the 200\u00a0V and 1000\u00a0V ranges are hardware limited to a nominal output of less than \u00b142\u00a0V.When the interlock is not asserted:", - "param_info": [ - { - "name": "interlockStatus", - "description": "The status of the interlock", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlocktrippedinterlockStatus", - "range": "" - } - ], - "usage": [ - "interlockStatus = smu.interlock.tripped" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.interlock.tripped);", - "description": "If the interlock is not asserted, returns smu.OFF.\n--- --If the interlock is asserted, returns smu.ON.\n" - } - ], - "related_commands": [ - "smu.interlock.enable" - ] - }, - { - "name": "smu.measure.sense", - "webhelpfile": "25730.htm", - "signature": "", - "command_return": "sensing", - "type": "Attribute (RW)", - "default_value": "smu.SENSE_2WIRE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects local (2-wire) or remote (4-wire) sensing.", - "details": "This command determines if 2-wire (local) or 4-wire (remote) sensing is used.When you use 4-wire sensing, voltages are measured at the device under test (DUT). For the source voltage, if the sensed voltage is lower than the programmed amplitude, the voltage source increases the voltage until the sensed voltage is the same as the programmed amplitude. This compensates for IR drop in the output test leads.Using 4-wire sensing with voltage measurements eliminates any voltage drops that may be in the test leads between the Model 2470 and the DUT.When you are using 2-wire sensing, voltage is measured at the output connectors.When you are measuring resistance, you can enable 4-wire sensing to make 4-wire resistance measurements.When the output is off, 4-wire sensing is disabled and the instrument uses 2-wire sense, regardless of the sense setting. When the output is on, the selected sense setting is used.If the output is on when you change the sense setting, the output is turned off. ", - "param_info": [ - { - "name": "sensing", - "description": "Two-wire sensing", - "enum": "smu.SENSE_2WIRE nil|smu.SENSE_4WIRE nil", - "type": "smumeasuresensesensing", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuresensefunction", - "range": "" - } - ], - "usage": [ - "sensing = smu.measure.sense", - "smu.measure.sense = sensing", - "sensing = smu.measure.getattribute(function, ATTR_MEAS_SENSE)", - "smu.measure.setattribute(function, ATTR_MEAS_SENSE, sensing)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;", - "description": "Set the measurement function to resistance.\n--- --Set the sense to 4-wire remote.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.terminals", - "webhelpfile": "25737.htm", - "signature": "", - "command_return": "terminals", - "type": "Attribute (RW)", - "default_value": "smu.TERMINALS_FRONT\n", - "tsp_link": "Yes\n", - "description": "This attribute describes which set of input and output terminals the instrument is using.", - "details": "This command selects which set of input and output terminals the instrument uses. You can select front panel or rear panel terminals.If the output is on when you change from one set of terminals to the other, the output is turned off.This command replaces the smu.measure.terminals command, which is deprecated.", - "param_info": [ - { - "name": "terminals", - "description": "Use the front-panel input and output terminals", - "enum": "smu.TERMINALS_FRONT nil|smu.TERMINALS_REAR nil", - "type": "smuterminalsterminals", - "range": "" - } - ], - "usage": [ - "terminals = smu.terminals", - "smu.terminals = terminals" - ], - "overloads": [], - "examples": [ - { - "example": "smu.terminals = smu.TERMINALS_FRONT;", - "description": "Use the front-panel terminals for measurements.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.state()", - "webhelpfile": "25741.htm", - "signature": "trigger.model.state()", - "command_return": "status, status, n", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the present state of the trigger model.", - "details": "This command returns the state of the trigger model. The instrument checks the state of a started trigger model every 100\u00a0ms.This command returns the trigger state and the block that the trigger model last executed.The trigger model states are:", - "param_info": [ - { - "name": "status", - "description": "The status of the trigger model", - "enum": "trigger.STATE_ABORTED nil|trigger.STATE_ABORTING nil|trigger.STATE_BUILDING nil|trigger.STATE_EMPTY nil|trigger.STATE_FAILED nil|trigger.STATE_IDLE nil|trigger.STATE_RUNNING nil|trigger.STATE_WAITING nil", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "status", - "description": "The status of the parallel/dual trigger model", - "enum": "", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "n", - "description": "The last trigger model block that was executed", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status, status, n = trigger.model.state()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.state());", - "description": "An example output if the trigger model is waiting and is at block 9 would be:\n--- --trigger.STATE_WAITING trigger.STATE_EMPTY 9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "27637.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all events from the event log, including entries in the front-panel event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "eventlog.next()", - "eventlog.save()" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "27658.htm", - "signature": "eventlog.next(eventType)", - "command_return": "eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log.", - "details": "When an event occurs on the instrument, it is placed in the event log. The eventlog.next() command retrieves an unread event from the event log. Once an event is read, it can no longer be accessed remotely. However, it can be viewed on the front panel. When localnode.showevents is enabled, this command never returns an event because those events are automatically read and sent to the remote interface.To read multiple events, execute this command multiple times.If there are no entries in the event log, the following is returned:If the event type is not defined, an event of any type is returned.", - "param_info": [ - { - "name": "eventNumber", - "description": "The event number", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "message", - "description": "A description of the event", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity of the event", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "nodeID", - "description": "The TSP-Link node where the event occurred or 0 if the event occurred on the local node", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeSeconds", - "description": "The seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeNanoSeconds", - "description": "The fractional seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlognexteventType", - "range": "" - } - ], - "usage": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()", - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next(eventType)" - ], - "overloads": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()" - ], - "examples": [ - { - "example": "print(eventlog.next(5));", - "description": "Get the oldest error or information event from the event log.\n--- --Example output:\n--- ---285 TSP Syntax error at line 1: unexpected symbol near `0' 1 0 1367806152 652040060\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.getcount()", - "eventlog.save()" - ] - }, - { - "name": "file.read()", - "webhelpfile": "27929.htm", - "signature": "file.read(fileNumber, readAction)", - "command_return": "fileContents", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file on the USB flash drive.", - "details": "This command reads data from a file.", - "param_info": [ - { - "name": "fileContents", - "description": "The contents of the file based on the readAction parameter", - "enum": "", - "type": "string | nil", - "range": "" - }, - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to read", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "readAction", - "description": "The action", - "enum": "file.READ_LINE nil|file.READ_NUMBER nil|file.READ_ALL nil", - "type": "filereadreadAction", - "range": "" - } - ], - "usage": [ - "fileContents = file.read(fileNumber, readAction)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_READ);if file_num != nil then; file_contents = file.read(file_num, file.READ_ALL); file.close(file_num);end;", - "description": "Open testfile.txt on the USB flash drive for reading. If it opens successfully, read the entire contents of the file and store it in variable file_contents.\n--- --Close the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.close()", - "webhelpfile": "27930.htm", - "signature": "file.close(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes a file on the USB flash drive.", - "details": "Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to close", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.close(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/GENTRIGGER\", file.MODE_WRITE);file.close(file_num);", - "description": "Open the file GENTRIGGER for writing, then close it.\n" - } - ], - "related_commands": [ - "file.open()" - ] - }, - { - "name": "file.write()", - "webhelpfile": "27934.htm", - "signature": "file.write(fileNumber, string)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file on the USB flash drive.", - "details": "The file.write() function may include data that is buffering; it may not be written to the USB flash drive immediately. Use the file.flush() function to immediately write buffered data to the drive.You must use the file.close() command to close the file after writing.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to write", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "string", - "description": "A string that contains the data to write to the file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.write(fileNumber, string)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "file.close()", - "file.flush() " - ] - }, - { - "name": "file.flush()", - "webhelpfile": "27958.htm", - "signature": "file.flush(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffering data to a file on the USB flash drive.", - "details": "The file.write() function may be buffering data instead of writing immediately to the USB flash drive. Use file.flush() to flush this data. Data may be lost if the file is not closed or flushed before a script ends.If there is going to be a time delay before more data is written to a file, flush the file to prevent loss of data because of an aborted test.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to flush", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.flush(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();\u00a0;-- Fix the range to 10 V;smu.measure.range = 10;\u00a0;-- Set the measurement count to 100;smu.measure.count = 100;\u00a0;-- Set up reading buffers;-- Ensure the default measurement buffer size matches the count;defbuffer1.capacity = 100;smu.measure.read();\u00a0;testDir = \"TestData5\";\u00a0;-- create a directory on the USB drive for the data;file.mkdir(testDir);fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";buffer.save(defbuffer1, fileName);\u00a0;if file.usbdriveexists() != 0 then; -- testDir = \"TestData3\";\u00a0; -- Create a directory on the USB drive for the data; -- file.mkdir(testDir); -- Open the file where the data will be stored; -- fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\"; fileNumber = file.open(fileName, file.MODE_APPEND);-- Write header separator to file; file.write(fileNumber, \"\\n\\n====================================================================\\n\");-- Write the string data to a file; file.write(fileNumber, \"Tested to Company Standard ABC.123\\n\");-- Ensure a hurry-up of data written to the file before close or script end; file.flush(fileNumber);-- Close the data file; file.close(fileNumber);\u00a0;end;", - "description": "This example writes a string that indicates that the readings were made for a certain reason, such as to test to a company standard.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.output", - "webhelpfile": "28022.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "When the output is switched on, the instrument sources either voltage or current, as set by smu.source.func.", - "param_info": [ - { - "name": "sourceOutput", - "description": "Switch the source output off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceoutputsourceOutput", - "range": "" - } - ], - "usage": [ - "sourceOutput = smu.source.output", - "smu.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.output = smu.ON;", - "description": "Switch the source output of the instrument to on.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.offmode" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "28048.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "format.LITTLEENDIAN\n", - "tsp_link": "No\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.REAL32 and format.REAL64 data formats.If you are sending data to a computer with a Microsoft Windows operating system, select the format.LITTLEENDIAN byte order.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.BIGENDIAN nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "Output depends on the terminal program you use, but will look something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "28056.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "0 (Automatic)\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number from 1 to 16; set to 0 to have the instrument select the precision automatically based on the number that is being formatted", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "28063.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "format.ASCII\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "You can control the precision of numeric values with the format.asciiprecision attribute. If format.REAL32 or format.REAL64 is selected, you can select the byte order with the format.byteorder attribute.The IEEE Std 754 binary formats use four bytes for single-precision values and eight bytes for double-precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCII nil|format.REAL32 nil|format.REAL64 nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "trigger.lanin[N].edge", - "webhelpfile": "28111.htm", - "signature": "", - "command_return": "edgeMode", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_EITHER\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.", - "param_info": [ - { - "name": "edgeMode", - "description": "The trigger mode; see the Details for more information", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "edgeMode = trigger.lanin[N].edge", - "trigger.lanin[N].edge = edgeMode" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[1].edge = trigger.EDGE_FALLING;", - "description": "Set the edge state of LAN event 1 to falling.\n" - } - ], - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "smu.measure.displaydigits", - "webhelpfile": "28416.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "smu.DIGITS_5_5\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the number of digits that are displayed for measurements on the front panel for the selected function.", - "details": "This command affects how the reading for a measurement is displayed on the front panel of the instrument. It does not affect the number of digits returned in a remote command reading. It also does not affect the accuracy or speed of measurements.The display digits setting is saved with the function setting, so if you use another function, then return to the function for which you set display digits, the display digits setting you set previously is retained.The change in digits occurs the next time a measurement is made.To change the number of digits returned in a remote command reading, use format.asciiprecision.", - "param_info": [ - { - "name": "digits", - "description": "6\u00bd display digits", - "enum": "smu.DIGITS_6_5 nil|smu.DIGITS_5_5 nil|smu.DIGITS_4_5 nil|smu.DIGITS_3_5 nil", - "type": "smumeasuredisplaydigitsdigits", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuredisplaydigitsfunction", - "range": "" - } - ], - "usage": [ - "digits = smu.measure.displaydigits", - "smu.measure.displaydigits = digits", - "digits = smu.measure.getattribute(function, ATTR_MEAS_DIGITS)", - "smu.measure.setattribute(function, ATTR_MEAS_DIGITS, digits)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.displaydigits = smu.DIGITS_6_5;", - "description": "Set the measurement function to voltage with a front-panel display resolution of 6\u00bd.\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "smu.measure.configlist.catalog()", - "webhelpfile": "28417.htm", - "signature": "smu.measure.configlist.catalog()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one measure configuration list that is stored on the instrument.", - "details": "You can use this command to retrieve the names of measure configuration lists that are stored in the instrument. This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no measure configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "output", - "description": "Returns the name of one measure configuration list that is stored on the instrument", - "enum": "", - "type": "string | nil", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.catalog());", - "description": "Request the name of one measure configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.query()", - "webhelpfile": "28418.htm", - "signature": "smu.measure.configlist.query(listName, index, fieldSeparator)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command recalls data for one configuration index.For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "output", - "description": "Returns a list of TSP commands and parameter settings that are stored in the specified configuration index", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = smu.measure.configlist.query(listName, index)", - "output = smu.measure.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "output = smu.measure.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(smu.measure.configlist.query(\"testMeasList\", 2, \"\\n\"));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n--- --Example output:\n--- --smu.measure.func = smu.FUNC_DC_CURRENT\n--- --smu.measure.range = 1.000000e-08\n--- --smu.measure.autorange = smu.ON\n--- --smu.measure.autorangelow = 1.000000e-08\n--- --smu.measure.autozero.enable = smu.ON\n--- --smu.measure.displaydigits = smu.DIGITS_5_5\n--- --smu.measure.filter.enable = smu.OFF\n--- --smu.measure.filter.count = 10\n--- --smu.measure.filter.type = smu.FILTER_REPEAT_AVG\n--- --smu.measure.limit[1].autoclear = smu.ON\n--- --smu.measure.limit[1].enable = smu.OFF\n--- --smu.measure.limit[1].high.value = 1.000000e+00\n--- --smu.measure.limit[1].low.value = -1.000000e+00\n--- --smu.measure.limit[2].autoclear = smu.ON\n--- --smu.measure.limit[2].enable = smu.OFF\n--- --smu.measure.limit[2].high.value = 1.000000e+00\n--- --smu.measure.limit[2].low.value = -1.000000e+00\n--- --smu.measure.math.enable = smu.OFF\n--- --smu.measure.math.format = smu.MATH_PERCENT\n--- --smu.measure.math.mxb.bfactor = 0.000000e+00\n--- --smu.measure.math.mxb.mfactor = 1.000000e+00\n--- --smu.measure.math.percent = 1.000000e+00\n--- --smu.measure.userdelay[1] = 0.000000e+00\n--- --smu.measure.userdelay[2] = 0.000000e+00\n--- --smu.measure.userdelay[3] = 0.000000e+00\n--- --smu.measure.userdelay[4] = 0.000000e+00\n--- --smu.measure.userdelay[5] = 0.000000e+00\n--- --smu.measure.nplc = 1.000000e+00\n--- --smu.measure.offsetcompensation = smu.OFF\n--- --smu.measure.sense = smu.SENSE_2WIRE\n--- --smu.terminals = smu.TERMINALS_FRONT\n--- --smu.measure.unit = smu.UNIT_AMP\n--- --smu.measure.rel.enable = smu.OFF\n--- --smu.measure.rel.level = 0.000000e+00\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.configlist.recall()", - "webhelpfile": "28419.htm", - "signature": "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a configuration index in a measure configuration list and an optional source configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a measure configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified measure configuration list. You can optionally specify a source configuration list and index to recall with the measure settings. If you do not specify a source index, the source index defaults to match the measure index. Specify a measure and source list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need the source and measure configuration lists coordinated, you can specify just the measure configuration list with this command and use the smu.source.configlist.recall() command to recall source settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, an error message is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. A single index stores the settings associated with a single measure function.This command recalls data for one configuration index from the specified measure configuration list and from the source configuration list (if specified).For additional information about the information this command recalls when using a configuration list query command, see Settings stored in a measure configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sourceListName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceIndex", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)", - "smu.measure.configlist.recall(listName, index, sourceListName, sourceIndex)" - ], - "overloads": [ - "smu.measure.configlist.recall(listName)", - "smu.measure.configlist.recall(listName, index)", - "smu.measure.configlist.recall(listName, index, sourceListName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.recall(\"MyMeasList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()", - "smu.measure.configlist.store()" - ] - }, - { - "name": "smu.measure.configlist.delete()", - "webhelpfile": "28421.htm", - "signature": "smu.measure.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a measure configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.delete(listName)", - "smu.measure.configlist.delete(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.delete(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.delete(\"myMeasList\");", - "description": "Delete a measure configuration list named myMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "lan.macaddress", - "webhelpfile": "28423.htm", - "signature": "", - "command_return": "MACaddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute describes the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets.", - "param_info": [ - { - "name": "MACaddress", - "description": "The MAC address of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "MACaddress = lan.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.macaddress);", - "description": "Returns the MAC address. For example:\n--- --08:00:11:00:00:57\n" - } - ], - "related_commands": [ - "lan.ipconfig()" - ] - }, - { - "name": "smu.measure.autozero.enable", - "webhelpfile": "29048.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "To ensure the accuracy of readings, the instrument must periodically get new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture that is being used for measurements. The Model 2470 uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made.The time to make the reference measurements is in addition to the normal measurement time. If timing is critical, such as in sweeps, you can disable autozero to avoid this time penalty.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "state", - "description": "The status of autozero; set to one of the following values", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautozeroenablestate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautozeroenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autozero.enable", - "smu.measure.autozero.enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_AUTO_ZERO)", - "smu.measure.setattribute(function, ATTR_MEAS_AUTO_ZERO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autozero.enable = smu.OFF;", - "description": "Set autozero off for voltage measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.once()", - "smu.measure.nplc" - ] - }, - { - "name": "smu.measure.autozero.once()", - "webhelpfile": "29049.htm", - "signature": "smu.measure.autozero.once()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to refresh the reference and zero measurements once.", - "details": "This command forces a refresh of the reference and zero measurements that are used for the present aperture setting for the selected function.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.", - "param_info": [ - { - "name": "smu.measure.autozero.once()", - "description": "Do a one-time refresh of the reference and zero measurements.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.autozero.once()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.autozero.once();", - "description": "Do a one-time refresh of the reference and zero measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.enable" - ] - }, - { - "name": "smu.measure.nplc", - "webhelpfile": "29064.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the time that the input signal is measured for the selected function.", - "details": "This command sets the amount of time that the input signal is measured.The amount of time is specified as the number of power line cycles (NPLCs). Each PLC for 60\u00a0Hz is 16.67\u00a0ms (1/60) and each PLC for 50\u00a0Hz is 20\u00a0ms (1/50). For 60\u00a0Hz, if you set the NPLC to 0.1, the measure time is 1.667 ms.This command is set for the measurement of specific functions (current, resistance, or voltage).The shortest amount of time results in the fastest reading rate but increases the reading noise and decreases the number of usable digits.The longest amount of time provides the lowest reading noise and more usable digits but has the slowest reading rate.Settings between the fastest and slowest number of power line cycles are a compromise between speed and noise.If you change the PLCs, you may want to adjust the displayed digits to reflect the change in usable digits.", - "param_info": [ - { - "name": "nplc", - "description": "The number of power line cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurenplcfunction", - "range": "" - } - ], - "usage": [ - "nplc = smu.measure.nplc", - "smu.measure.nplc = nplc", - "nplc = smu.measure.getattribute(function, ATTR_MEAS_NPLC)", - "smu.measure.setattribute(function, ATTR_MEAS_NPLC, nplc)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.nplc = 0.5;", - "description": "Set the measurement function to DC Voltage.\n--- --Set the NPLC value to 0.5, which is 0.0083\u00a0seconds (0.5/60).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.protect.level", - "webhelpfile": "29072.htm", - "signature": "", - "command_return": "PROTECT_x", - "type": "Attribute (RW)", - "default_value": "smu.PROTECT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the overvoltage protection setting of the source output.", - "details": "Overvoltage protection restricts the maximum voltage level that the instrument can source. It is in effect when either current or voltage is sourced.This protection is in effect for both positive and negative output voltages.When this attribute is used in a test sequence, it should be set before turning the source on.", - "param_info": [ - { - "name": "PROTECT_x", - "description": "The overvoltage protection level", - "enum": "smu.PROTECT_20V nil|smu.PROTECT_40V nil|smu.PROTECT_100V nil|smu.PROTECT_200V nil|smu.PROTECT_300V nil|smu.PROTECT_400V nil|smu.PROTECT_500V nil|smu.PROTECT_NONE nil", - "type": "smusourceprotectlevelPROTECT_x", - "range": "" - }, - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceprotectlevelsourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotectlevelfunction", - "range": "" - } - ], - "usage": [ - "PROTECT_x = smu.source.protect.level", - "smu.source.protect.level = PROTECT_x", - "PROTECT_x = smu.source.getattribute(function, ATTR_SRC_PROTECT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_PROTECT_LEVEL, PROTECT_x)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.protect.level = smu.PROTECT_40V;", - "description": "Sets the maximum voltage limit of the instrument to 40\u00a0V.\n" - } - ], - "related_commands": [ - "Overvoltage protection" - ] - }, - { - "name": "smu.source.delay", - "webhelpfile": "29079.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This command sets a delay for the selected source function. This delay is in addition to normal settling times.After the programmed source is turned on, this delay allows the source level to settle before a measurement is made.If you set a specific source delay (smu.source.delay), source autodelay is turned off.When source autodelay is turned on, the manual source delay setting is overwritten with the autodelay setting.When either a source delay or autodelay is set, the delay is applied to the first source output and then only when the magnitude of the source changes.", - "param_info": [ - { - "name": "sDelay", - "description": "The length of the delay (0 to 10 ks)", - "enum": "", - "type": "number", - "range": "(0 to 10 ks)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcedelayfunction", - "range": "" - } - ], - "usage": [ - "sDelay = smu.source.delay", - "smu.source.delay = sDelay", - "sDelay = smu.source.getattribute(function, ATTR_SRC_DELAY)", - "smu.source.setattribute(function, ATTR_SRC_DELAY, sDelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.delay = 3;", - "description": "Set the function to voltage. Set a 3 s delay after the source is turned on before a measurement is made.\n" - } - ], - "related_commands": [ - "smu.source.autodelay" - ] - }, - { - "name": "smu.measure.offsetcompensation", - "webhelpfile": "29137.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if offset compensation is used.", - "details": "This feature is only available for resistance measurements or when the smu.measure.unit is set to smu.UNIT_OHM.", - "param_info": [ - { - "name": "state", - "description": "Disable offset compensation", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureoffsetcompensationstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureoffsetcompensationfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.offsetcompensation", - "smu.measure.offsetcompensation = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_OFFSET_COMP)", - "smu.measure.setattribute(function, ATTR_MEAS_OFFSET_COMP, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_RESISTANCE;smu.measure.sense = smu.SENSE_4WIRE;smu.measure.offsetcompensation = smu.ON;smu.source.output = smu.ON;print(smu.measure.read());smu.source.output = smu.OFF;", - "description": "Sets the measurement function to resistance. Set the instrument for 4-wire measurements and turn offset compensation on. Turn on the source, make a measurement, and turn the source off.\n--- --Example output:\n--- --81592000\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.offmode", - "webhelpfile": "29238.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "smu.OFFMODE_NORMAL\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the state of the source when the output is turned off.", - "details": "", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values (see the Details below for specifics regarding each option)", - "enum": "smu.OFFMODE_NORMAL nil|smu.OFFMODE_ZERO nil|smu.OFFMODE_HIGHZ nil|smu.OFFMODE_GUARD nil", - "type": "smusourceoffmodesourceOffMode", - "range": "(see the Details below for specifics regarding each option)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceoffmodefunction", - "range": "" - } - ], - "usage": [ - "sourceOffMode = smu.source.offmode", - "smu.source.offmode = sourceOffMode", - "sourceOffMode = smu.source.getattribute(function, ATTR_SRC_OFFMODE)", - "smu.source.setattribute(function, ATTR_SRC_OFFMODE, sourceOffMode)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.offmode = smu.OFFMODE_HIGHZ;", - "description": "Sets the output-off state so that the instrument opens the output relay when the output is turned off.\n" - } - ], - "related_commands": [ - "smu.source.output" - ] - }, - { - "name": "smu.source.func", - "webhelpfile": "29382.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "smu.FUNC_DC_VOLTAGE\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "When you set this command, it configures the instrument as either a voltage source or a current source.When you read this command, it returns the output setting of the source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcefuncsFunction", - "range": "" - } - ], - "usage": [ - "sFunction = smu.source.func", - "smu.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;", - "description": "Sets the source function of the instrument to be a current source.\n" - } - ], - "related_commands": [ - "smu.source.level", - "smu.source.output" - ] - }, - { - "name": "smu.source.range", - "webhelpfile": "29383.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 1e-8\u00a0AVoltage: 0.2\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the range for the source for the selected source function.", - "details": "This command manually selects the measurement range for the specified source.To select the range, specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 3\u00a0V, set the source level to 3. The Model 2470 selects the 20\u00a0V range.If you select a specific source range, the range must be large enough to source the value. If not, an overrange condition can occur.If an overrange condition occurs, an event is displayed and the change to the setting is ignored.The fixed current source ranges are 10\u00a0nA, 100\u00a0nA, 1\u00a0\u00b5A, 10\u00a0\u00b5A, 100\u00a0\u00b5A, 1\u00a0mA, 10\u00a0mA, 100\u00a0mA, and 1\u00a0A.The fixed voltage source ranges are 200\u00a0mV, 2\u00a0V, 20\u00a0V, 200\u00a0V, and 1000\u00a0V.When you read this value, the instrument returns the positive full-scale value that the instrument is presently using.This command is intended to eliminate the time required by the automatic range selection.To select the range, you can specify the approximate source value that you will use. The instrument selects the lowest range that can accommodate that level. For example, if you expect to source levels around 50\u00a0mV, send 0.05 (or 50e-3) to select the 200\u00a0mV range.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced; see Details for values; the ranges are", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.source.range", - "smu.source.range = rangeValue", - "rangeValue = smu.source.getattribute(function, ATTR_SRC_RANGE)", - "smu.source.setattribute(function, ATTR_SRC_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.OFF;smu.source.range = 1;", - "description": "Set the instrument to source current.\n--- --Turn autorange off.\n--- --Set the source range to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.autorange" - ] - }, - { - "name": "smu.source.autorange", - "webhelpfile": "29386.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the range is selected manually or automatically for the selected source function or voltage source.", - "details": "This command indicates the state of the range for the selected source. When automatic source range is disabled, the source range is set manually.When automatic source range is enabled, the instrument selects the range that is most appropriate for the value that is being sourced. The output level controls the range. If you read the range after the output level is set, the instrument returns the range that the instrument chose as appropriate for that source level.If the source range is set to a specific value from the front panel or a remote command, the setting for automatic range is set to disabled.Only available for the current and voltage functions.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautorangesourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautorangefunction", - "range": "" - } - ], - "usage": [ - "sourceAutorange = smu.source.autorange", - "smu.source.autorange = sourceAutorange", - "sourceAutorange = smu.source.getattribute(function, ATTR_SRC_RANGE_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_RANGE_AUTO, sourceAutorange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.source.autorange = smu.ON;", - "description": "Set the source function to current.\n--- --Set the instrument to select the source range automatically.\n" - } - ], - "related_commands": [ - "smu.source.range" - ] - }, - { - "name": "smu.measure.autorange", - "webhelpfile": "29393.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the measurement range is set manually or automatically for the selected measure function.", - "details": "Autorange selects the best range in which to measure the signal that is applied to the input terminals of the instrument. When autorange is enabled, the range increases at 100 percent of range. The range decreases occur when the reading is <10\u00a0percent of nominal range.This command determines how the range is selected.When this command is set to off, you must set the range. If you do not set the range, the instrument remains at the range that was last selected by autorange.When this command is set to on, the instrument automatically goes to the most sensitive range to perform the measurement.", - "param_info": [ - { - "name": "autoRange", - "description": "Set the measurement range manually", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangeautoRange", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangefunction", - "range": "" - } - ], - "usage": [ - "autoRange = smu.measure.autorange", - "smu.measure.autorange = autoRange", - "autoRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_AUTO)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_AUTO, autoRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n" - } - ], - "related_commands": [ - "smu.measure.range" - ] - }, - { - "name": "smu.measure.range", - "webhelpfile": "29407.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Current: 10 nAResistance: 200,000\u00a0\u03a9Voltage: 0.2\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale measure range.", - "details": "You can assign any real number using this command. The instrument selects the closest fixed range that is large enough to measure the entered number. For example, for current measurements, if you expect a reading of approximately 9\u00a0mA, set the range to 9 mA to select the 10\u00a0mA range. When you read this setting, you see the positive full-scale value of the measurement range that the instrument is presently using.This command is primarily intended to eliminate the time that is required by the instrument to automatically search for a range.When a range is fixed, any signal greater than the entered range generates an overrange condition. When an overrange condition occurs, the front panel displays \"Overflow\" and the remote interface returns 9.9e+37.If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is the same as the source range, regardless of measurement range setting. However, the setting for the measure range is retained, and when the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.If you change the range while the output is off, the instrument does not update the hardware settings, but if you read the range setting, the return is the setting that will be used when the output is turned on. If you set a range while the output is on, the new setting takes effect immediately.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected value to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerangefunction", - "range": "" - } - ], - "usage": [ - "rangeValue = smu.measure.range", - "smu.measure.range = rangeValue", - "rangeValue = smu.measure.getattribute(function, ATTR_MEAS_RANGE)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 0.5;", - "description": "Set the source function to current.\n--- --Set the measurement function to voltage.\n--- --Instrument selects the 2 V measurement range.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangelow", - "webhelpfile": "29423.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 10\u00a0nAVoltage: 0.2\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the lower limit for measurements of the selected function when the range is selected automatically.", - "details": "You can use this command when automatic range selection is enabled. It prevents the instrument from selecting a range that is below this limit. Because the lowest ranges generally require longer settling times, setting the low limit that is appropriate for your application but above the lowest possible range can make measurements require less settling time.The lower limit must be less than the upper limit.Though you can send any value when you send this command, the instrument selects the next highest range value. For example, if you send 15 for the lowest voltage range, the instrument will be set to the 20\u00a0V range as the low limit. If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "lowRange", - "description": "The lower limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangelowfunction", - "range": "" - } - ], - "usage": [ - "lowRange = smu.measure.autorangerangelow", - "smu.measure.autorangerangelow = lowRange", - "lowRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_LOW)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_LOW, lowRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;smu.measure.autorangelow = 2;", - "description": "Sets the low range for voltage measurements to 2\u00a0V.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.measure.autorangehigh", - "webhelpfile": "29432.htm", - "signature": "", - "command_return": "highRange", - "type": "AttributeResistance: (RW)Voltage and current: (R)", - "default_value": "Resistance: 200e6\u00a0\u03a9\n", - "tsp_link": "Yes\n", - "description": "When autorange is selected, this attribute represents the highest measurement range that is used when the instrument selects the measurement range automatically.", - "details": "This command can be written to and read for resistance measurements. For current and voltage measurements, it can only be read.For current and voltage measurements, the upper limit is controlled by the current or voltage limit.For resistance measurements, you can use this command when automatic range selection is enabled to put an upper bound on the range that is used for resistance measurements.The upper limit must be more than the lower limit.If the lower limit is equal to the upper limit, automatic range setting is effectively disabled.", - "param_info": [ - { - "name": "highRange", - "description": "The highest measurement range that is used when the range is set automatically", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangehighfunction", - "range": "" - } - ], - "usage": [ - "highRange = smu.measure.autorangehigh", - "smu.measure.autorangehigh = highRange", - "highRange = smu.measure.getattribute(function, ATTR_MEAS_RANGE_HIGH)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_HIGH, highRange)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.autorange = smu.ON;print(smu.measure.autorangehigh);", - "description": "Sets the measurement function to voltage and turn autorange on. Check the high range for voltage measurements.\n" - } - ], - "related_commands": [ - "reset()", - "smu.measure.autorange", - "smu.reset()" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "29636.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the instrument to provide an audible signal at a specific frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.Using this function from a remote interface does not affect audible errors or key click settings that were made from the Model 2470 front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the beep (20\u00a0Hz to 8000 Hz)", - "enum": "", - "type": "number", - "range": "(20\u00a0Hz to 8000 Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(2, 2400);", - "description": "Generates a 2 s, 2400\u00a0Hz tone.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "29846.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete (OPC) bit after all pending commands, including overlapped commands, have been executed.", - "details": "This function causes the operation complete bit in the Status Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "smu.measure.limit[Y].enable", - "webhelpfile": "29884.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables a limit test on the measurement from the selected measure function.", - "details": "This command enables or disables a limit test for the selected measurement function. When this attribute is enabled, the limit Y testing occurs on each measurement made by the instrument. Limit Y testing compares the measurements to the high-limit and low-limit values. If a measurement falls outside these limits, the test fails.", - "param_info": [ - { - "name": "state", - "description": "Disable the test", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurelimitenablestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitenablefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].enable", - "smu.measure.limit[Y].enable = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.limit[1].enable = smu.ON;", - "description": "Enable testing for limit 1 when measuring voltage.\n" - } - ], - "related_commands": [ - "smu.measure.limit[Y].autoclear", - "smu.measure.limit[Y].clear()", - "smu.measure.limit[Y].fail", - "smu.measure.limit[Y].high.value", - "smu.measure.limit[Y].low.value" - ] - }, - { - "name": "smu.source.level", - "webhelpfile": "29907.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute immediately selects a fixed amplitude for the selected source function.", - "details": "This command sets the output level of the voltage or current source. If the output is on, the new level is sourced immediately.The sign of the source level dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.If a manual source range is selected, the level cannot exceed the specified range. For example, if the voltage source is on the 2\u00a0V range, you cannot set the voltage source level to 3\u00a0V. When autorange is selected, the amplitude can be set to any level supported by the instrument.", - "param_info": [ - { - "name": "sourceLevel", - "description": "Current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcelevelfunction", - "range": "" - } - ], - "usage": [ - "sourceLevel = smu.source.level", - "smu.source.level = sourceLevel", - "sourceLevel = smu.source.getattribute(function, ATTR_SRC_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LEVEL, sourceLevel)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 1;", - "description": "Set the instrument to source voltage and set it to source 1\u00a0V.\n" - } - ], - "related_commands": [ - "smu.source.func", - "smu.source.output", - "smu.source.protect.level" - ] - }, - { - "name": "smu.measure.rel.enable", - "webhelpfile": "29986.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the application of a relative offset value to the measurement.", - "details": "When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value calculated when you acquire the relative offset value.Each returned measured relative reading is the result of the following calculation:", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurerelenablerelEnable", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerelenablefunction", - "range": "" - } - ], - "usage": [ - "relEnable = smu.measure.rel.enable", - "smu.measure.rel.enable = relEnable", - "relEnable = smu.measure.getattribute(function, ATTR_MEAS_REL_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_ENABLE, relEnable)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;rel_value = smu.measure.rel.acquire();smu.measure.rel.enable = smu.ON;", - "description": "Acquires a relative offset level value for voltage measurements and turns the relative offset feature on.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.level" - ] - }, - { - "name": "smu.measure.rel.level", - "webhelpfile": "29987.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the relative offset value.", - "details": "This command specifies the relative offset value that can be applied to new measurements. When relative offset is enabled, all subsequent measured readings are offset by the value that is set for this\u00a0command.You can set this value, or have the instrument acquire a value. If the instrument acquires the value, read this setting to return the value that was measured\u00a0internally.", - "param_info": [ - { - "name": "relValue", - "description": "Relative offset value for measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurerellevelfunction", - "range": "" - } - ], - "usage": [ - "relValue = smu.measure.rel.level", - "smu.measure.rel.level = relValue", - "relValue = smu.measure.getattribute(function, ATTR_MEAS_REL_LEVEL)", - "smu.measure.setattribute(function, ATTR_MEAS_REL_LEVEL, relValue)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.rel.level = smu.measure.read();smu.measure.rel.enable = smu.ON;", - "description": "Sets the measurement function to current, performs a current measurement, uses it as the relative offset value, and enables the relative offset for current measurements.\n" - } - ], - "related_commands": [ - "smu.measure.rel.acquire()", - "smu.measure.rel.enable" - ] - }, - { - "name": "smu.measure.filter.count", - "webhelpfile": "30064.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements that are averaged when filtering is enabled.", - "details": "The filter count is the number of readings that are acquired and stored in the filter stack for the averaging calculation. When the filter count is larger, more filtering is done, and the data is less noisy.This command is set for the selected function.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltercountfunction", - "range": "" - } - ], - "usage": [ - "filterCount = smu.measure.filter.count", - "smu.measure.filter.count = filterCount", - "filterCount = smu.measure.getattribute(function, ATTR_MEAS_FILTER_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_COUNT, filterCount)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.enable", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.filter.type", - "webhelpfile": "30065.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "smu.FILTER_REPEAT_AVG\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the type of averaging filter that is used for the selected measure function when the measurement filter is enabled.", - "details": "You can select one of two types of averaging filters: repeating average or moving average.When the repeating average filter is selected, a set of measurements are made. These measurements are stored in a measurement stack and averaged together to produce the averaged sample. Once the averaged sample is produced, the stack is flushed, and the next set of data is used to produce the next averaged sample. This type of filter is the slowest, since the stack must be completely filled before an averaged sample can be produced.When the moving average filter is selected, the measurements are added to the stack continuously on a first-in, first-out basis. As each measurement is made, the oldest measurement is removed from the stack. A new averaged sample is produced using the new measurement and the data that is now in the stack.The repeating average filter produces slower results but produces more stable results than the moving average filter. For either method, the greater the number of measurements that are averaged, the slower the averaged sample rate, but the lower the noise error. Trade-offs between speed and noise are normally required to tailor the instrumentation to your measurement application.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled; set to one of the following values", - "enum": "smu.FILTER_MOVING_AVG nil|smu.FILTER_REPEAT_AVG nil", - "type": "smumeasurefiltertypefilterType", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefiltertypefunction", - "range": "" - } - ], - "usage": [ - "filterType = smu.measure.filter.type", - "smu.measure.filter.type = filterType", - "filterType = smu.measure.getattribute(function, ATTR_MEAS_FILTER_TYPE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_TYPE, filterType)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.enable" - ] - }, - { - "name": "smu.measure.filter.enable", - "webhelpfile": "30066.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the averaging filter for the selected measurement function.", - "details": "This command enables or disables the averaging filter. When this is enabled, the reading returned by the instrument is an averaged value, taken from multiple measurements. The settings of the filter count and filter type for the selected measure function determines how the reading is averaged.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasurefilterenablefilterState", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurefilterenablefunction", - "range": "" - } - ], - "usage": [ - "filterState = smu.measure.filter.enable", - "smu.measure.filter.enable = filterState", - "filterState = smu.measure.getattribute(function, ATTR_MEAS_FILTER_ENABLE)", - "smu.measure.setattribute(function, ATTR_MEAS_FILTER_ENABLE, filterState)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.filter.count = 10;smu.measure.filter.type = smu.FILTER_MOVING_AVG;smu.measure.filter.enable = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "smu.measure.filter.count", - "smu.measure.filter.type" - ] - }, - { - "name": "smu.measure.math.mxb.bfactor", - "webhelpfile": "30107.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the offset, b, for the y = mx + b operation.", - "details": "This attribute specifies the offset (b) for an mx + b operation.The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation:Where:", - "param_info": [ - { - "name": "value", - "description": "The offset for the y = mx + b operation; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbbfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.bfactor", - "smu.measure.math.mxb.bfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_BF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_BF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx +b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.mfactor" - ] - }, - { - "name": "smu.measure.math.mxb.mfactor", - "webhelpfile": "30108.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the scale factor, m, for the y = mx + b math operation.", - "details": "This command sets the scale factor (m) for an mx + b operation for the selected measurement function.The mx + b math operation lets you manipulate normal display readings (x) mathematically according to the following calculation:Where: ", - "param_info": [ - { - "name": "value", - "description": "The scale factor; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathmxbmfactorfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.mxb.mfactor", - "smu.measure.math.mxb.mfactor = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_MXB_MF)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_MXB_MF, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_MXB;smu.measure.math.mxb.mfactor = 0.80;smu.measure.math.mxb.bfactor = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operation to mx+b.\n--- --Set the scale factor for the mx+b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.mxb.bfactor" - ] - }, - { - "name": "smu.measure.math.percent", - "webhelpfile": "30109.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the reference constant that is used when math operations are set to percent.", - "details": "This is the constant that is used when the math operation is set to percent for the selected measurement function.The percent math function displays measurements as percent deviation from a specified reference constant. The percent calculation is:Where:", - "param_info": [ - { - "name": "value", - "description": "The reference used when the math operation is set to percent; the range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuremathpercentfunction", - "range": "" - } - ], - "usage": [ - "value = smu.measure.math.percent", - "smu.measure.math.percent = value", - "value = smu.measure.getattribute(function, ATTR_MEAS_MATH_PERCENT)", - "smu.measure.setattribute(function, ATTR_MEAS_MATH_PERCENT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.math.format = smu.MATH_PERCENT;smu.measure.math.percent = 50;smu.measure.math.enable = smu.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operations to percent.\n--- --Set the percentage value to 50 for voltage measurements.\n--- --Enable math operations.\n" - } - ], - "related_commands": [ - "smu.measure.math.enable", - "smu.measure.math.format" - ] - }, - { - "name": "smu.source.protect.tripped", - "webhelpfile": "30235.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the overvoltage source protection feature is active.", - "details": "When overvoltage protection is active, the instrument restricts the maximum voltage level that the instrument can source.", - "param_info": [ - { - "name": "value", - "description": "Overvoltage protection not active", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceprotecttrippedvalue", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceprotecttrippedfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.protect.tripped", - "value = smu.source.getattribute(function, ATTR_SRC_PROTECT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.protect.tripped);", - "description": "If overvoltage protection is active, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "Overvoltage protection", - "smu.source.protect.level" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "30485.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all readings and statistics from the specified buffer.", - "details": "", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);testData.clear();print(\"Readings in buffer after clear =\" .. testData.n);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);", - "description": "Create a reading buffer named testData, make three readings and store them in testData, and then view the readings.\n--- --Print number of readings in testData.\n--- --Output:\n--- ---4.5010112303956e-10, -3.9923108222095e-12, -4.5013931471161e-10\n--- --Clear the readings in testData.\n--- --Verify that there are no readings in testData.\n--- --Output:\n--- --Readings in buffer after clear = 0\n--- --Store three new readings in testData and view those when complete.\n--- --Output:\n--- --4.923509754e-07, 3.332266330e-07, 3.974883867e-07\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.dates", - "webhelpfile": "30488.htm", - "signature": "bufferVar.dates[N]", - "command_return": "date", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the dates of readings that are stored in the reading buffer.", - "details": "The dates are formatted as month, day, year.This is not available if the reading buffer style is set to compact.", - "param_info": [ - { - "name": "date", - "description": "The date of readings stored in bufferVar element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "date = bufferVar.dates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 1, testData);trigger.model.initiate();waitcomplete();print(testData.dates[1]);printbuffer(1, testData.n, testData.dates);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Example output:\n--- --11/27/2017\n--- --Prints the dates for readings 1 through the last reading in the buffer.\n--- --Example output:\n--- --11/27/2017, 11/27/2017, 11/27/2017\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "30489.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "User-defined buffer: buffer.FILL_ONCE (0)defbuffer1: buffer.FILL_CONTINUOUS (1)defbuffer2: buffer.FILL_CONTINUOUS (1)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if a reading buffer is filled continuously or is filled once and stops.", - "details": "When a reading buffer is set to fill once, no data is overwritten in the buffer. When the buffer is filled, no more data is stored in that buffer and new readings are discarded.When a reading buffer is set to fill continuously, the oldest data is overwritten by the newest data after the buffer fills.When you change the fill mode of a buffer, any data in the buffer is cleared.", - "param_info": [ - { - "name": "fillMode", - "description": "Fill the buffer, then stop", - "enum": "buffer.FILL_ONCE nil|buffer.FILL_CONTINUOUS nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);print(testData.fillmode);testData.fillmode = buffer.FILL_CONTINUOUS;print(testData.fillmode);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer. Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --0\n--- --Set fill mode to continuous. \n--- --Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.digout[N].stimulus", - "webhelpfile": "30501.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line.", - "details": "The digital trigger pulsewidth command determines how long the trigger is asserted.The trigger stimulus for a digital I/O line can be set to one of the trigger events that are described in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "event = trigger.digout[N].stimulus", - "trigger.digout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].stimulus = trigger.EVENT_TIMER3;", - "description": "Set the stimulus for output digital trigger line 2 to be the expiration of trigger timer 3.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()", - "trigger.digout[N].assert()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "30502.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the text from the front-panel USER swipe screen.", - "details": "", - "param_info": [ - { - "name": "display.clear()display.changescreen(display.SCREEN_USER_SWIPE)display.settext(display.TEXT1, \"Serial number:\")display.settext(display.TEXT2, localnode.serialno)", - "description": "Clear the USER swipe screen.Set the first line to read \"Serial number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"Serial number:\");display.settext(display.TEXT2, localnode.serialno);", - "description": "Clear the USER swipe screen.\n--- --Set the first line to read \"Serial number:\" and the second line to display the serial number of the instrument.\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "display.changescreen()", - "webhelpfile": "30503.htm", - "signature": "display.changescreen(screenName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function changes which front-panel screen is displayed.", - "details": "", - "param_info": [ - { - "name": "screenName", - "description": "The screen to display", - "enum": "display.SCREEN_HOME nil|display.SCREEN_HOME_LARGE_READING nil|display.SCREEN_READING_TABLE nil|display.SCREEN_GRAPH nil|display.SCREEN_HISTOGRAM nil|display.SCREEN_GRAPH_SWIPE nil|display.SCREEN_SETTINGS_SWIPE nil|display.SCREEN_SOURCE_SWIPE nil|display.SCREEN_STATS_SWIPE nil|display.SCREEN_USER_SWIPE nil|display.SCREEN_PROCESSING nil", - "type": "displaychangescreenscreenName", - "range": "" - } - ], - "usage": [ - "display.changescreen(screenName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT1, \"Batch A122\");display.settext(display.TEXT2, \"Test running\");display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clear the USER swipe screen.\n--- --Set the first line of the USER swipe screen to read \"Batch A122\" and the second line to display \"Test running\".\n--- --Display the USER swipe screen.\n--- --\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "localnode.showevents", - "webhelpfile": "30504.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (no events sent)\n", - "tsp_link": "No\n", - "description": "This attribute sets whether or not the instrument automatically outputs generated events to the remote interface.", - "details": "Enable this attribute to have the instrument output generated events to the remote interface.Events are output after a command message is executed but before prompts are issued (if prompts are enabled with localnode.prompts).If this attribute is disabled, use eventlog.next() to retrieve unread events from the event log.Events are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable show events when the GPIB connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "errorMode", - "description": "The errors that are returned", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "localnodeshoweventserrorMode", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showevents", - "localnode.showevents = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showevents = eventlog.SEV_ERROR | eventlog.SEV_INFO;trigger.digin[3].edge = trigger.EDGE_EITHER;", - "description": "Send generated error and warning messages.\n--- --Example output if the edge cannot be sent to either:\n--- --1805, Settings conflict: setting input edge when line 3 set for digital\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "localnode.prompts" - ] - }, - { - "name": "smu.measure.count", - "webhelpfile": "30505.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements to make when a measurement is requested.", - "details": "This command sets the number of measurements that are made when a measurement is requested. This command does not affect the trigger model.When smu.measure.count or if the function for smu.measure.setattribute is the active function, this command sets the count for all measure functions. When you send smu.measure.setattribute for a function that is not active, only the count for the specified function is changed.If you set the count to a value that is larger than the capacity of the reading buffer and the buffer fill mode is set to continuous, the buffer wraps until the number of readings specified have occurred. The earliest readings in the count are overwritten. If the buffer is set to fill once, readings stop when the buffer is filled, even if the count is not complete.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements (1 to 300,000 or buffer capacity)", - "enum": "", - "type": "integer", - "range": "(1 to 300,000 or buffer capacity)" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurecountfunction", - "range": "" - } - ], - "usage": [ - "count = smu.measure.count", - "smu.measure.count = count", - "count = smu.measure.getattribute(function, ATTR_MEAS_COUNT)", - "smu.measure.setattribute(function, ATTR_MEAS_COUNT, count)" - ], - "overloads": [], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1;smu.measure.count = 200; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;smu.measure.read(defbuffer1);\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses smu.measure.count to do a capacitor test. This outputs 200 readings that are similar to the following output:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - }, - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example demonstrates how to use the SimpleLoop trigger-model template instead of smu.measure.count to do a capacitor test. Similar to Example 1, this also outputs 200 readings that are similar to the following:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "smu.measure.read()", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.reset()", - "webhelpfile": "30521.htm", - "signature": "smu.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smu. to their default settings.", - "details": "This function turns off the output and resets the commands that begin with smu. to their default settings. It also deletes source and measure configuration lists.", - "param_info": [ - { - "name": "smu.reset()", - "description": "Turns off the output and resets the SMU commands to their default settings.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smu.reset();", - "description": "Turns off the output and resets the SMU commands to their default settings.\n" - } - ], - "related_commands": [ - "reset()" - ] - }, - { - "name": "status.operation.getmap()", - "webhelpfile": "30523.htm", - "signature": "status.operation.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Operation Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "setEvent, clearEvent = status.operation.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.getmap(0));", - "description": "Query bit 0 of the Operation Event Register.\n--- --Example output:\n--- --4918 4917\n" - } - ], - "related_commands": [ - "Operation Event Register", - "Programmable status register sets", - "status.operation.setmap()" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "30524.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Event Register.", - "details": "This query reads the contents of the questionable status event register. After sending this command and addressing the instrument to talk, a value is sent to the computer. This value indicates which bits in the appropriate register are set.The Questionable Register can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set the Questionable Register to the sum of their decimal weights. For example, to set bits B12 and B13, set the Questionable Register to 12,288 (which is the sum of 4,096\u00a0+\u00a08,192).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the questionable status register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.event" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 66 = binary 0100 0010;questionableRegister = 66;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B1 and B6 of the status questionable enable register.\n" - }, - { - "example": "-- decimal 2560 = binary 00001010 0000 0000;questionableRegister = 2560;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B9 and B11 of the status questionable enable register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "30525.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or sets the bits in the Status Enable register of the Standard Event Register.", - "details": "When a bit in the Status Enable register is set on and the corresponding bit in the Standard Event Status register is set on, the ESB bit of the Status Byte Register is set to on.To set a bit on, send the constant or value of the bit as the standardRegister parameter.You can set the bit as a constant or a numeric value, as shown in the table below. To set more than one bit of the register, you can send multiple constants with + between them. You can also set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B2, set standardRegister to 5 (which is the sum of 1 + 4). You can also send:status.standard.enable = status.standard.OPC + status.standard.QYEWhen zero (0) is returned, no bits are set. You can also send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The value of the Status Enable register of the Standard Event Register (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "standardRegister = status.standard.enable", - "status.standard.enable = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.QYE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and QYE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 5 = binary 0000 0101;standardRegister = 5;status.standard.enable = standardRegister;", - "description": "Uses a decimal value to set the OPC and QYE bits of the standard event status enable register.\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "trigger.timer[N].start.generate", - "webhelpfile": "30536.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies when timer events are generated.", - "details": "When this is set to on, a trigger event is generated immediately when the timer is triggered.When it is set to off, a trigger event is generated when the timer elapses. This generates the event trigger.EVENT_TIMERN.", - "param_info": [ - { - "name": "state", - "description": "Generate a timer event when the timer delay elapses", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerstartgeneratestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.generate", - "trigger.timer[N].start.generate = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;", - "description": "Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "bufferVar.sourceformattedvalues", - "webhelpfile": "30538.htm", - "signature": "bufferVar.sourceformattedvalues[N]", - "command_return": "values", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels formatted as they appear on the front-panel display when the readings in the reading buffer were acquired.", - "details": "The attribute is an array (a Lua table) of the sourced value that was in effect at the time of the reading. The source levels are formatted the same way the readings are formatted when they appear on the front-panel display.", - "param_info": [ - { - "name": "values", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "values = bufferVar.sourceformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 6, 0);trigger.model.initiate();waitcomplete();print(defbuffer1.sourceformattedvalues[1]);printbuffer(1,6,defbuffer1.sourceformattedvalues);", - "description": "Example output:\n--- ---00.00041 mV\n--- --Example output:\n--- ---00.00041 mV, +00.00010 mV, -00.00033 mV, +00.00003 mV, -00.00028 mV, -00.00045 mV\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fractionalseconds", - "webhelpfile": "30542.htm", - "signature": "bufferVar.fractionalseconds[N]", - "command_return": "fractionalSec", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the fractional second portion of the timestamp of each reading in the reading buffer.", - "details": "This read-only attribute is an array of the fractional portion of the timestamp, in seconds, when each reading occurred. Seconds are shown as fractions.", - "param_info": [ - { - "name": "fractionalSec", - "description": "The fractional second portion of the timestamp to 1\u00a0ns resolution", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "fractionalSec = bufferVar.fractionalseconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();print(testData.fractionalseconds[1]);printbuffer(1, 6, testData.fractionalseconds);", - "description": "Create a reading buffer named testData and make six measurements.\n--- --Print the fractional portion of the timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0.647118937\n--- --Print the fractional portion of the timestamp for the first six readings in the buffer.\n--- --Example output:\n--- --0.647118937, 0.064543, 0.48196127, 0.89938724, 0.316800064, 0.734218263\n" - } - ], - "related_commands": [ - "bufferVar.seconds", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "30545.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();for x = 1, 3 do printbuffer(x, x, testData.readings, testData.sourcevalues, testData.relativetimestamps) end;", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the three readings in testData, including the measurement, source value, and relative timestamp.\n--- --Output:\n--- ---9.6420389034124e-12, 2, 0\n--- ---4.5509945811872e-10, 2, 0.277194856\n--- ---9.1078204006445e-12, 2, 0.569614783\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "30550.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourceValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "This attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.The values returned by this command depend on the source readback state:", - "param_info": [ - { - "name": "sourceValue", - "description": "The output value of the source when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "sourceValue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.func = smu.FUNC_DC_CURRENT;smu.source.level = 1e-6;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 3, testData.sourcevalues);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the source value to 1e-6\u00a0A.\n--- --Print the source values being output when readings in the reading buffer were acquired. \n--- --Example output:\n--- --9.9999874692e-07, 1.0000017028e-06, 1.0000054544e-06\n" - } - ], - "related_commands": [ - "bufferVar.sourcestatuses", - "bufferVar.sourceunits", - "bufferVar.statuses", - "bufferVar.formattedreadings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()", - "smu.source.readback" - ] - }, - { - "name": "tsplink.initialize()", - "webhelpfile": "30551.htm", - "signature": "tsplink.initialize(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes all instruments and enclosures in the TSP-Link system.", - "details": "If the only node on the TSP-Link network is the one running the command and expectedNodes is not provided, this function generates an error event. If you set expectedNodes to 1, the node is initialized.If you include expectedNodes, if nodesFound is less than expectedNodes, an error event is generated.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes found on the system, including the node on which the command is running", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 32)", - "enum": "", - "type": "integer", - "range": "(1 to 32)" - } - ], - "usage": [ - "nodesFound = tsplink.initialize()", - "nodesFound = tsplink.initialize(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.initialize()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.initialize(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link initialization and indicate how many nodes are found.\n--- --Example output if two nodes are found:Nodes found = 2\n--- --Example output if fewer nodes are found and if localnode.showevents = 7:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "related_commands": [ - "Initializing the TSP-Link system", - "localnode.showevents", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "eventlog.getcount()", - "webhelpfile": "30552.htm", - "signature": "eventlog.getcount(eventType)", - "command_return": "count", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of unread events in the event log.", - "details": "A count finds the number of unread events in the event log. You can specify the event types to return or return the count for all events.This command reports the number of events that have occurred since the command was last sent or since the event log was last cleared.Events are read automatically when localnode.showevents is enabled. You can also read them individually with eventlog.next().", - "param_info": [ - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventloggetcounteventType", - "range": "" - }, - { - "name": "count", - "description": "A count finds the number of unread events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = eventlog.getcount()", - "count = eventlog.getcount(eventType)" - ], - "overloads": [ - "count = eventlog.getcount()" - ], - "examples": [ - { - "example": "print(eventlog.getcount(eventlog.SEV_INFO));", - "description": "Displays the present number of unread information messages in the instrument event log.\n--- --If there are three information messages in the event log, output is:\n--- --3\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.next()", - "localnode.showevents" - ] - }, - { - "name": "trigger.timer[N].start.overrun", - "webhelpfile": "30553.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.", - "param_info": [ - { - "name": "state", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].start.overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].start.stimulus", - "webhelpfile": "30555.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the event that starts the trigger timer.", - "details": "Set the stimulus to any trigger event to start the timer when that event occurs.Set the stimulus to none to disable event processing and use the timer as a timer or alarm based on the start time.Trigger events are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event that starts the trigger timer; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.timer[N].start.stimulus", - "trigger.timer[N].start.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;trigger.timer[1].delay = 3e-3;trigger.timer[1].start.stimulus = trigger.EVENT_DIGIO3;", - "description": "Set digital I/O line 3 to be a trigger input.\n--- --Set timer 1 to delay for 3\u00a0ms.\n--- --Set timer 1 to start the timer when an event is detected on digital I/O line 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.configlist.store()", - "webhelpfile": "30559.htm", - "signature": "smu.measure.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active measure settings into the named configuration list.", - "details": "Use this command to store the active measure settings to a configuration index in a configuration list. If the index parameter is not provided, the new settings are appended to the end of the list. The index only stores the active settings for a single active measure function.Configuration lists are not saved when the instrument is turned off or reset. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.Refer to Settings stored in a measure configuration index for a complete list of measure settings that the instrument stores.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.store(listName)", - "smu.measure.configlist.store(listName, index)" - ], - "overloads": [ - "smu.measure.configlist.store(listName)" - ], - "examples": [ - { - "example": "smu.measure.configlist.store(\"MyConfigList\");", - "description": "Stores the active settings of the instrument to the end of the configuration list MyConfigList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.measure.unit", - "webhelpfile": "30560.htm", - "signature": "", - "command_return": "unitOfMeasure", - "type": "Attribute (RW)", - "default_value": "Current: smu.UNIT_AMPResistance: smu.UNIT_OHMVoltage: smu.UNIT_VOLT\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.", - "details": "The change in measurement units is displayed when the next measurement is made.", - "param_info": [ - { - "name": "unitOfMeasure", - "description": "The units of measure to be displayed for the measurement", - "enum": "smu.UNIT_AMP nil|smu.UNIT_OHM nil|smu.UNIT_VOLT nil|smu.UNIT_WATT nil", - "type": "smumeasureunitunitOfMeasure", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureunitfunction", - "range": "" - } - ], - "usage": [ - "unitOfMeasure = smu.measure.unit", - "smu.measure.unit = unitOfMeasure", - "unitOfMeasure = smu.measure.getattribute(function, ATTR_MEAS_UNIT)", - "smu.measure.setattribute(function, ATTR_MEAS_UNIT, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.unit = smu.UNIT_WATT;", - "description": "Changes the front-panel display and buffer readings for voltage measurements to be displayed as power readings in watts.\n" - } - ], - "related_commands": [ - "smu.measure.func" - ] - }, - { - "name": "smu.source.ilimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 105\u00a0\u00b5ACurrent: 21\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2470 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.ilimit.level", - "smu.source.ilimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.vlimit.level", - "webhelpfile": "30561.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Voltage: 105\u00a0\u00b5ACurrent: 21\u00a0V\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the source limit for measurements.", - "details": "This command sets the source limit for measurements. The values that can be set for this command are limited by the setting for the overvoltage protection limit.The Model 2470 cannot source levels that exceed this limit.If you change the measure range to a range that is not appropriate for this limit, the instrument changes the source limit to a limit that is appropriate to the range and a warning is generated. Depending on the source range, your actual maximum limit value could be lower. The instrument makes adjustments to stay in the operating boundaries.This value can also be limited by the measurement range. If a specific measurement range is set, the limit must be 10.6% or higher of the measurement range. If you set the measurement range to be automatically selected, the measurement range does not affect the limit.Limits are absolute values.You can use smu.source.xlimit.tripped to check the limit state of the source output.", - "param_info": [ - { - "name": "value", - "description": "The limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "x", - "description": "The function for which to set the limit", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimitlevelfunction", - "range": "" - } - ], - "usage": [ - "value = smu.source.vlimit.level", - "smu.source.vlimit.level = value", - "value = smu.source.getattribute(function, ATTR_SRC_LIMIT_LEVEL)", - "smu.source.setattribute(function, ATTR_SRC_LIMIT_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 1;", - "description": "Set the source function to voltage with the current limit set to 1\u00a0A.\n" - } - ], - "related_commands": [ - "smu.source.protect.level", - "smu.source.xlimit.tripped" - ] - }, - { - "name": "smu.source.ilimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.ilimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.vlimit.tripped", - "webhelpfile": "30562.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the source exceeded the limits that were set for the selected measurements.", - "details": "You can use this command to check the limit state of the source.If the limits were exceeded, the instrument clamps the source to keep the source within the set limits.If you check the limit for the source that is not presently selected, nil is returned.", - "param_info": [ - { - "name": "state", - "description": "Indicates if the limit has been tripped", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "x", - "description": "The function whose limit was tripped", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcexlimittrippedfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.vlimit.tripped", - "state = smu.source.getattribute(function, ATTR_SRC_LIMIT_TRIPPED)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.vlimit.tripped);", - "description": "Check the state of the source limit for voltage. If the limit was exceeded, the output is:\n--- --smu.ON\n" - } - ], - "related_commands": [ - "smu.source.xlimit.level" - ] - }, - { - "name": "smu.source.sweeplinear()", - "webhelpfile": "30563.htm", - "signature": "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear sweep for a fixed number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears any existing trigger models, creates a source configuration list, and populates the trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10\u00a0ms for the source delay and 25\u00a0ms for the sweep delay, the actual delay is 35\u00a0ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. ", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50\u00a0\u00b5s to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearrangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplineardual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinear(configListName, start, stop, points)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinear(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.source.sweeplinear(\"VoltLinSweep\", 0, 10, 20, 1e-3, 1, smu.RANGE_FIXED);smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set up a linear sweep that sweeps from 0 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLinSweep.\n--- --Set the measure function to current.\n--- --Set the current range to 100 \u03bcA.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "smu.source.sweeplinearstep()", - "webhelpfile": "30565.htm", - "signature": "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a linear source sweep configuration list and trigger model with a fixed number of steps.", - "details": "When the sweep is started, the instrument sources a specific voltage or current voltage to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it deletes the existing trigger model and creates a trigger model with a uniform series of ascending or descending voltage or current changes, called steps. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the stop level, which is calculated from the number of steps. A measurement is performed at each source step (including the start and stop levels). At this level, the instrument performs another measurement and then stops the sweep.The instrument uses the step size parameter to determine the number of source level changes. The source level changes in equal steps from the start level to the stop level. To avoid a setting conflicts error, make sure the step size is greater than the start value and less than the stop value. To calculate the number of source-measure points in a sweep, use the following formula: Points = [(Stop - Start) / Step] + 1When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "step", - "description": "The step size at which the source level will change; must be more than 0", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplinearstepsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplinearstepcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplinearsteprangeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplinearstepdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "overloads": [ - "smu.source.sweeplinearstep(configListName, start, stop, step)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplinearstep(configListName, start, stop, step, sDelay, count, rangeType, failAbort, dual)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 1;smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;smu.source.sweeplinearstep(\"CurrLogSweep\", -1.05, 1.05, .25, 10e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to current.\n--- --Set the source range to 1\u00a0A. Set the measure function to voltage with a range of 20\u00a0V.\n--- --Set up a linear step sweep that sweeps from -1.05\u00a0A to 1.05\u00a0A in 0.25\u00a0A increments with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep CurrLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.sweeplog()", - "webhelpfile": "30566.htm", - "signature": "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a logarithmic sweep for a set number of measurement points.", - "details": "When the sweep is started, the instrument sources a specific voltage or current value to the device under test (DUT). A measurement is made for each point of the sweep.When the sweep command is sent, it clears the existing trigger model and creates a new trigger model. To run the sweep, initiate the trigger model.The sweep continues until the source outputs the specified stop level. At this level, the instrument performs another measurement and then stops the sweep.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.The range type specifies the source range that is used for the sweep. You can select the following options:You cannot use a writable reading buffer to collect data from a sweep. The asymptote changes the inflection of the sweep curve and allows it to sweep through zero. You can use the asymptote parameter to customize the inflection and offset of the source value curve. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep. The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.", - "param_info": [ - { - "name": "configListName", - "description": "A string that contains the name of the configuration list that the instrument will create for this sweep", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "start", - "description": "The voltage or current source level at which the sweep starts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "The voltage or current at which the sweep stops", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of source-measure points between the start and stop values of the sweep (2 to 1e6); to calculate the number of source-measure points in a sweep, use the following formula", - "enum": "", - "type": "integer", - "range": "(2 to 1e6)" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is smu.DELAY_AUTO, which enables autodelay, or a specific delay value from 50 \u03bcs to 10 ks, or 0 for no delay", - "enum": "smu.DELAY_AUTO 0", - "type": "smusourcesweeplogsDelay | number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplogcount | integer", - "range": "" - }, - { - "name": "rangeType", - "description": "The source range that is used for the sweep", - "enum": "smu.RANGE_AUTO nil|smu.RANGE_BEST nil|smu.RANGE_FIXED nil", - "type": "smusourcesweeplograngeType", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogfailAbort", - "range": "" - }, - { - "name": "dual", - "description": "Determines if the sweep runs from start to stop and then from stop to start", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplogdual", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "asymptote", - "description": "Default is 0; see Details", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName, asymptote)" - ], - "overloads": [ - "smu.source.sweeplog(configListName, start, stop, points)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual)", - "smu.source.sweeplog(configListName, start, stop, points, sDelay, count, rangeType, failAbort, dual, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.range = 20;smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.range = 100e-6;smu.source.sweeplog(\"VoltLogSweep\", 1, 10, 20, 1e-3, 1, smu.RANGE_FIXED);trigger.model.initiate();", - "description": "Reset the instrument to its defaults.\n--- --Set the source function to voltage.\n--- --Set the source range to 20\u00a0V.\n--- --Set the measure function to current.\n--- --Set the current range to 100 uA.\n--- --Set up a log sweep that sweeps from 1 to 10 V in 20 steps with a source delay of 1\u00a0ms, a sweep count of 1, and a fixed source range. Name the configuration list that is created for this sweep VoltLogSweep.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.clear()", - "webhelpfile": "30567.htm", - "signature": "status.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears event registers.", - "details": "This command clears the event registers of the Questionable Event and Operation Event Register set. It does not affect the Questionable Event Enable or Operation Event Enable registers.", - "param_info": [ - { - "name": "status.clear()", - "description": "Clear the bits in the registers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "status.clear();", - "description": "Clear the bits in the registers\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.getblocklist()", - "webhelpfile": "30569.htm", - "signature": "trigger.model.getblocklist()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the settings for all trigger model blocks.", - "details": "This returns the settings for the trigger model.", - "param_info": [ - { - "name": "output", - "description": "Returns the settings for the trigger model", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getblocklist()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.getblocklist());", - "description": "Returns the settings for the trigger model. Example output is:\n--- -- 1) BUFFER_CLEAR BUFFER: defbuffer1\n--- -- 2) MEASURE BUFFER: defbuffer1 COUNT: 1\n--- -- 3) BRANCH_COUNTER VALUE: 5 BRANCH_BLOCK: 2\n--- -- 4) DELAY_CONSTANT DELAY: 1.000000000\n--- -- 5) BRANCH_COUNTER VALUE: 3 BRANCH_BLOCK: 2\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()" - ] - }, - { - "name": "trigger.model.getbranchcount()", - "webhelpfile": "30570.htm", - "signature": "trigger.model.getbranchcount(blockNumber)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the count value of the trigger model counter block.", - "details": "This command returns the counter value. When the counter is active, this returns the present count. If the trigger model has started or is running but has not yet reached the counter block, this value is 0.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "output", - "description": "Returns the count value of the trigger model counter block.", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getbranchcount(blockNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 0.1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);trigger.model.initiate();delay(1);print(trigger.model.getbranchcount(4));waitcomplete();", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and make five readings.\n--- --Delay 0.1 s.\n--- --Loop ten more times back to block 2.\n--- --Send the count command to check which count has been completed for block 4.\n--- --At end of execution, 10 readings are stored in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.initiate()", - "webhelpfile": "30571.htm", - "signature": "trigger.model.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function starts the trigger model.", - "details": "", - "param_info": [], - "usage": [ - "trigger.model.initiate()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.model.abort()" - ] - }, - { - "name": " trigger.BLOCK_BUFFER_CLEAR", - "webhelpfile": "30574.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that clears the reading buffer.", - "details": "When trigger model execution reaches the buffer clear trigger block, the instrument empties the specified reading buffer. The specified buffer can be the default buffer or a buffer that you defined.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_BUFFER_CLEAR, capTest2);", - "description": "Assign trigger block 3 to buffer clear; when the trigger model reaches block 3, it clears the reading buffer named capTest2.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Buffer clear block" - ] - }, - { - "name": "trigger.timer[N].enable", - "webhelpfile": "30576.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables the trigger timer.", - "details": "When this command is set to on, the timer performs the delay operation.When this command is set to off, there is no timer on the delay operation.You must enable a timer before it can use the delay settings or the alarm configuration. For expected results from the timer, it is best to disable the timer before changing a timer setting, such as delay or start seconds.To use the timer as a simple delay or pulse generator with digital I/O lines, make sure the timer start time in seconds and fractional seconds is configured for a time in the past. To use the timer as an alarm, configure the timer start time in seconds and fractional seconds for the desired alarm time.", - "param_info": [ - { - "name": "state", - "description": "Disable the trigger timer", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerenablestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].enable", - "trigger.timer[N].enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].enable = trigger.ON;", - "description": "Enable the trigger timer for timer 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.logstate", - "webhelpfile": "30577.htm", - "signature": "bufferVar.logstate", - "command_return": "logState", - "type": "Attribute (RW)", - "default_value": "defbuffer1: buffer.ON (1)defbuffer2: buffer.ON (1)User-created buffer: buffer.OFF (0)\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if information events are logged when the specified reading buffer is at 0% or 100% filled.", - "details": "If this is set to on, when the reading buffer is cleared (0% filled) or full (100% filled), an event is logged in the event log. If this is set to off, reading buffer status is not reported in the event log.", - "param_info": [ - { - "name": "logState", - "description": "Do not log information events", - "enum": "buffer.OFF nil|buffer.ON nil", - "type": "bufferVarlogstatelogState", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "logState = bufferVar.logstate", - "bufferVar.logstate = logState" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;MyBuffer = buffer.make(500);print(MyBuffer.logstate);", - "description": "Create the user-defined buffer MyBuffer.\n--- --Print the log state of MyBuffer.\n--- --Output:\n--- --0\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.readback", - "webhelpfile": "30579.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument records the measured source value or the configured source value when making a measurement.", - "details": "When source readback is off, the instrument records and displays the source value you set. When you use the actual source value (source readback on), the instrument measures the actual source value immediately before making the measurement of the device under test.Using source readback results in more accurate measurements, but also a reduction in measurement speed.When source readback is on, the front-panel display shows the measured source value and the buffer records the measured source value immediately before the device-under-test measurement. When source readback is off, the front-panel display shows the configured source value and the buffer records the configured source value immediately before the device-under-test measurement.", - "param_info": [ - { - "name": "state", - "description": "Disable readback", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcereadbackstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcereadbackfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.readback", - "smu.source.readback = state", - "state = smu.source.getattribute(function, ATTR_SRC_READBACK)", - "smu.source.setattribute(function, ATTR_SRC_READBACK, state)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testDataBuffer = buffer.make(100);smu.source.func = smu.FUNC_DC_VOLTAGE;smu.measure.func = smu.FUNC_DC_CURRENT;smu.source.readback = smu.ON;smu.source.level = 10;smu.measure.count = 100;smu.source.output = smu.ON;smu.measure.read(testDataBuffer);smu.source.output = smu.OFF;printbuffer(1, 100, testDataBuffer.sourcevalues, testDataBuffer);", - "description": "Reset the instrument to default settings.\n--- --Make a buffer named testDataBuffer that can hold 100 readings.\n--- --Set source function to voltage.\n--- --Set the measurement function to current.\n--- --Set read back on.\n--- --Set the instrument to take 100 readings.\n--- --Turn the output on.\n--- --Take the measurements.\n--- --Turn the output off.\n--- --Get the source values and measurements from the buffer.\n" - } - ], - "related_commands": [ - "smu.measure.func", - "smu.source.func" - ] - }, - { - "name": "smu.source.highc", - "webhelpfile": "30580.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When the instrument is measuring low current and is driving a capacitive load, you may see overshoot, ringing, and instability. You can enable the high capacitance mode to minimize these problems.", - "param_info": [ - { - "name": "state", - "description": "Turn high-capacitance mode off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcehighcstate", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcehighcfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.highc", - "smu.source.highc = state", - "state = smu.source.getattribute(function, ATTR_SRC_HIGHC)", - "smu.source.setattribute(function, ATTR_SRC_HIGHC, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.highc = smu.ON;", - "description": "Turn the high capacitance mode on.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - DurationLoop", - "webhelpfile": "30588.htm", - "signature": "trigger.model.load(DurationLoop, duration, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements for a specified amount of time.", - "details": "When you load this trigger-model template, you can specify amount of time to make a measurement and the length of the delay before the measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "DurationLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "duration", - "description": "The amount of time for which to make measurements (167 ns to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(167 ns to 100\u00a0ks)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)", - "trigger.model.load(DurationLoop, duration, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.level = 5; ;-- Turn on output, initiate readings, and store them in defbuffer1;trigger.model.load(\"DurationLoop\", 10, 0.01, defbuffer1);trigger.model.initiate();", - "description": "Reset the instrument. Set the instrument to source voltage at 5\u00a0V. Set to measure current.\n--- --Load the duration loop trigger model to take measurements for 10 s with a 10\u00a0ms delay before each measurement.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "30981.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines.", - "details": "This function writes to the digital I/O port by setting the binary state of each digital line from an integer equivalent value.The binary representation of the value indicates the output pattern to be written to the I/O port. For example, a value of 63 has a binary equivalent of 111111 (all lines are set high); a data value of 42 has a binary equivalent of 101010 (lines 2, 4, and 6 are set high, and the other three lines are set low).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.You can also enter the data parameter as a binary value.", - "param_info": [ - { - "name": "data", - "description": "The value to write to the port (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(63);", - "description": "Sets digital I/O lines 1 through 6 high (binary 111111).\n" - }, - { - "example": "digio.writeport(0b111111);", - "description": "Sets digital I/O lines 1 through 6 high (digital\u00a063).\n" - } - ], - "related_commands": [ - "digio.readport()", - "Outputting a bit pattern" - ] - }, - { - "name": "digio.line[N].state", - "webhelpfile": "30982.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low when the line is set for digital control and returns the state on the digital I/O lines.", - "details": "When a reset occurs, the digital line state can be read as high because the digital line is reset to a digital input. A digital input floats high if nothing is connected to the digital line.This returns the integer equivalent values of the binary states on all six digital I/O lines.Set the state to digio.STATE_LOW to clear the bit; set the state to digio.STATE_HIGH to set the bit.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "state", - "description": "Set the line low", - "enum": "digio.STATE_LOW nil|digio.STATE_HIGH nil", - "type": "digiolinestatestate", - "range": "" - } - ], - "usage": [ - "digio.line[N].state = state", - "state = digio.line[N].state" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_DIGITAL_OUT;digio.line[1].state = digio.STATE_HIGH;", - "description": "Sets line 1 (bit B1) of the digital I/O port high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.readport()", - "digio.writeport()", - "trigger.digin[N].edge" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "31076.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger timer settings to their default values.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their default values:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 to their default values.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].enable", - "trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.generate", - "trigger.timer[N].start.overrun", - "trigger.timer[N].start.seconds", - "trigger.timer[N].start.stimulus" - ] - }, - { - "name": " trigger.BLOCK_WAIT", - "webhelpfile": "31093.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that waits for an event before allowing the trigger model to continue.", - "details": "The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger block allows trigger execution to continue (see Details)", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "(see Details)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITclear", - "range": "" - }, - { - "name": "logic", - "description": "If each event must occur before the trigger model continues", - "enum": "trigger.WAIT_AND nil|trigger.WAIT_OR nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITlogic", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)" - ], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);", - "description": "Set trigger model block 9 to wait for a user to press the TRIGGER key on the front panel before continuing.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_MEASURE_DIGITIZE", - "webhelpfile": "31094.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that makes or digitizes a measurement.", - "details": "Digitized measurements are not a feature on the Model 2470. However, you can use this command to communicate with other Keithley instruments that do offer the digitized measurements feature and to share code with other Keithley instruments.Firmware versions of the Model 2470 before version 1.7.0 had a separate measure block. If you have code that is using that block, it works in this version of the Model 2470 firmware.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "count", - "description": "The number of measure or digitize readings to make before moving to the next block in the trigger model; set to", - "enum": "trigger.COUNT_INFINITE nil|trigger.COUNT_STOP nil|trigger.COUNT_AUTO nil", - "type": "triggermodelsetblocktriggerBLOCK_MEASURE_DIGITIZEcount", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)" - ], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set the function to measure DC voltage.\n--- --Set block 1 to clear defbuffer1.\n--- --Set block 2 to set a delay of 0.\n--- --Set block 3 to make measurements infinitely.\n--- --Set block 4 to wait until the front-panel TRIGGER key is pressed.\n--- --Set block 5 to stop making measurements.\n--- --Set block 6 to send a notification.\n--- --Start the trigger model.\n--- --You must press the front-panel TRIGGER key to stop measurements.\n--- --Output the number of readings.\n" - }, - { - "example": "reset();smu.measure.configlist.create(\"countactive\");smu.measure.count = 2;smu.measure.configlist.store(\"countactive\") -- index1;smu.measure.count = 10;smu.measure.configlist.store(\"countactive\") -- index2;smu.measure.count = 3;smu.measure.configlist.store(\"countactive\") -- index3;\u00a0;trigger.model.setblock(1, trigger.BLOCK_CONFIG_NEXT, \"countactive\");trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_AUTO);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 3, 1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set up a configuration list named countactive.\n--- --Set the measure count to 2 (replace smu.measure.count with smu.digitize.count if using a digitize function.)\n--- --Store the count in index 1.\n--- --Set the measure count to 10.\n--- --Store the count in index 2.\n--- --Set the measure count to 3.\n--- --Store the count in index 3.\n--- --Set up trigger model block 1 to call the next index from the countactive configuration list.\n--- --Set block 2 to measure or digitize and store the readings in defbuffer1, using the most recent count value.\n--- --Set block 3 to add a delay of 1\u00a0s.\n--- --Set block 4 to iterate through the trigger model 3 times, returning to block 1.\n--- --Start the trigger model.\n--- --Output the number of readings. There should be 15 readings.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Measure/Digitize block" - ] - }, - { - "name": " trigger.BLOCK_SOURCE_OUTPUT", - "webhelpfile": "31095.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that turns the output source on or off.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "Turn the source off", - "enum": "smu.OFF nil|smu.ON nil", - "type": "triggermodelsetblocktriggerBLOCK_SOURCE_OUTPUTstate", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_SOURCE_OUTPUT, state) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);", - "description": "Set trigger model to turn the source on when it reaches block 2.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_RECALL", - "webhelpfile": "31096.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the system settings that are stored in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.When the trigger model reaches a configuration recall block, the settings in the specified configuration list are recalled if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are recalled from the next index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.You can restore a specific set of configuration settings in the configuration list by defining the index.If you need to swap the source and measure configuration lists, you need to delete this block and create a new Config List Recall block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list to recall; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalIndex", - "description": "The index to recall from the second configuration list; defaults to 1", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList, optionalIndex)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index, optionalConfigList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5);", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5,; \"sourTrigList\") ;print(trigger.model.getblocklist());", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList and load index 1 from the configuration list name sourTrigList.\n--- --Query the configuration of the block.\n--- --Output:\n--- --5) CONFIG_RECALL CONFIG_LIST: measTrigList and sourTrigList INDEX: 5 and 1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_NEXT", - "webhelpfile": "31097.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the settings at the next index of a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "The name of the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");", - "description": "Configure trigger block 5 to load the next index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\");trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 1 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 1\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_NEXT CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the next index in both the configuration list named measTrigList and the configuration list named sourTrigList. \n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_PREV", - "webhelpfile": "31098.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list, or both a source and measure configuration list.", - "details": "If two configuration lists are specified with this command, they must not be of the same type. For example, if the first configuration list is a measure configuration list, the second configuration list must be a source configuration list. The order of the configuration lists does not matter with this command, as long as they are of the opposite type.The Config List Prev block defines a trigger model block that recalls the settings stored at the previous index in a source or measure configuration list if a single configuration list is specified. If both measure and source configuration lists are specified, measure and source settings are each recalled from the previous index in each list when this block is reached. The index numbers recalled may not match; it depends on the number of indexes in each list and what index number each list is on.The configuration list previous index trigger block type recalls the previous index in a configuration list. It configures the source or measure settings of the instrument based on the settings at that index. The trigger model executes the settings at that index before the next block is executed.The first time the trigger model encounters this block, the last index in the configuration list is recalled if the list has not already had an index recalled by the recall block command in an earlier trigger model block. If the configuration list has recalled an index with the recall block, the previous index in the list is called instead of the last. For example, the recall block recalls index 1 by default, so if the trigger model uses a recall block before this one, the first time the previous block is reached after that recall, the last index is recalled. However, if the recall block recalled index 3, the previous block would recall index 2. Each subsequent time trigger model execution reaches a configuration list previous block for this configuration list, it goes backward one index. When the first index in the list is reached, it goes to the last index in the configuration list.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the source or measure configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "optionalConfigList", - "description": "A string that defines the second configuration list to recall the index from; must be the opposite type of list than the first; for example, if the first configuration list is a measure list, the second configuration list must be a source list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList, optionalConfigList)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(8, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");", - "description": "Configure trigger block 8 to load the previous index in the configuration list named measTrigList.\n" - }, - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 3);trigger.model.setblock(2, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(3, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model.\n--- --Recall index 3 of a configuration list named measTrigList.\n--- --Clear reading buffer named defbuffer1.\n--- --Then, recall the second index of a configuration list named measTrigList.\n--- --Output:\n--- --1) CONFIG_RECALL CONFIG_LIST: measTrigList INDEX: 3\n--- --2) BUFFER_CLEAR BUFFER: defbuffer1\n--- --3) CONFIG_PREV CONFIG_LIST: measTrigList\n" - }, - { - "example": "trigger.model.setblock(7, trigger.BLOCK_CONFIG_PREV, \"measTrigList\", \"sourTrigList\");", - "description": "Configure trigger block 7 to load the previous index in both the configuration list named measTrigList and the configuration list named sourTrigList.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_DELAY_DYNAMIC", - "webhelpfile": "31101.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a user delay to the execution of the trigger model.", - "details": "Each measure function can have up to five unique user delay times (M1 to M5). Each source function can also have up to five unique user delay times (S1 to S5). The delay time is set by the user-delay command, which is only available over a remote interface. Though the trigger model can be used with any function, the user delay is set per function. Make sure you are setting the delay for the function you intend to use with the trigger model.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "userDelay", - "description": "The number of the user delay", - "enum": "trigger.USER_DELAY_M nil|trigger.USER_DELAY_S nil", - "type": "triggermodelsetblocktriggerBLOCK_DELAY_DYNAMICuserDelay", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "smu.measure.userdelay[N]", - "smu.source.userdelay[N]" - ] - }, - { - "name": " trigger.BLOCK_DIGITAL_IO", - "webhelpfile": "31102.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that sets the lines on the digital I/O port high or low.", - "details": "The bit mask defines the bits in the pattern that are driven high or low. A binary 1 in the bit mask indicates that the corresponding I/O line should be driven according to the bit pattern. To drive all lines, specify all ones (63, 0x3F, 0b111111) or omit this parameter. If the bit for a line in the bit pattern is set to 1, the line is driven high. If the bit is set to 0 in the bit pattern, the line is driven low.For this block to work as expected, make sure you configure the trigger type and line state of the digital line for use with the trigger model (use the digital line mode command).", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bitPattern", - "description": "Sets the value that specifies the output line bit pattern (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - }, - { - "name": "bitMask", - "description": "Specifies the bit mask; if omitted, all lines are driven (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)" - ], - "overloads": [], - "examples": [ - { - "example": "for x = 3, 6 do digio.line[x].mode = digio.MODE_DIGITAL_OUT end;trigger.model.setblock(4, trigger.BLOCK_DIGITAL_IO, 20, 60);", - "description": "The for loop configures digital I./O lines 3 through 6 as digital outputs. Trigger block 4 is then configured with a bit pattern of 20 (digital I/O lines 3 and 5 high). The optional bit mask is specified as 60 (lines 3 through 6), so both lines 3 and 5 are driven high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_COUNTER", - "webhelpfile": "31103.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that branches to a specified block a specified number of times.", - "details": "This command defines a trigger model building block that branches to another block using a counter to iterate a specified number of times.Counters increment every time the trigger model reaches them until they are more than or equal to the count value. At that point, the trigger model continues to the next building block in the sequence.The counter is reset to 0 when the trigger model starts. It is incremented each time trigger model execution reaches the counter block.If you are using remote commands, you can query the counter. The counter is incremented immediately before the branch compares the actual counter value to the set counter value. Therefore, the counter is at 0 until the first comparison. When the trigger model reaches the set counter value, branching stops and the counter value is one greater than the setting. Use trigger.model.getbranchcount() to query the counter.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetCount", - "description": "The number of times to repeat", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the counter is less than the targetCount value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);print(trigger.model.getbranchcount(4));", - "description": "When the trigger model reaches this block, the trigger model returns to block 2. This repeats 10 times.\n--- --An example of the return if the trigger model has reached this block 5 times is:\n--- --5\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_RESET_BRANCH_COUNT" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ON_EVENT", - "webhelpfile": "31104.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function branches to a specified block when a specified trigger event occurs.", - "details": "If you are using a timer, it must be started before it can expire. One method to start the timer in the trigger model is to include a Notify block before the On Event block. Set the Notify block to use the same timer as the On Event block.The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger model branches the specified block", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the specified event occurs", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ON_EVENT, trigger.EVENT_DISPLAY, 2);", - "description": "When the trigger model reaches this block, if the front-panel TRIGGER key has been pressed, the trigger model returns to block 2. If the TRIGGER key has not been pressed, the trigger model continues to block 7 (the next block in the trigger model).\n" - } - ], - "related_commands": [ - "On event block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_CONSTANT", - "webhelpfile": "31105.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if a measurement meets preset criteria.", - "details": "The type of limit can be:The measurement block must be a measure/digitize block that occurs in the trigger model before the branch-on-constant-limits block. The last measurement from a measure/digitize block is used.If the limit A is more than the limit B, the values are automatically swapped so that the lesser value is used as the lower limit.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitType", - "range": "" - }, - { - "name": "limitA", - "description": "The lower limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitA", - "range": "" - }, - { - "name": "limitB", - "description": "The upper limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitB", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the defined criteria", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, trigger.LIMIT_ABOVE, 0.1, 1, 2);", - "description": "Sets trigger block 5 to be a constant limit that branches to block 2 when the measurement is above the value set for limit B (which is set to 1). Note that limit A must be set but is ignored. \n" - } - ], - "related_commands": [ - "Constant Limit block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_DELTA", - "webhelpfile": "31107.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.", - "details": "This block calculates the difference between the last two measurements from a measure/digitize block. It subtracts the most recent measurement from the previous measurement.The difference between the measurements is compared to the target difference. If the difference is less than the target difference, the trigger model goes to the specified branching block. If the difference is more than the target difference, the trigger model proceeds to the next block in the trigger block sequence.If you do not define the measure/digitize block, it will compare measurements of a measure/digitize block that precedes the branch delta block. For example, if you have a measure/digitize block, a wait block, another measure/digitize block, another wait block, and then the branch delta block, the delta block compares the measurements from the second measure/digitize block. If a preceding measure/digitize block does not exist, an error occurs.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetDifference", - "description": "The value against which the block compares the difference between the measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the difference between the measurements is less than or equal to the targetDifference", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_DELTA, 0.35, 8, 3);", - "description": "Configure trigger block 5 to branch to block 8 when the measurement difference from block 3 is less than 0.35.\n" - } - ], - "related_commands": [ - "Delta block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE", - "webhelpfile": "31108.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.", - "details": "The branch-once building block branches to a specified block the first time trigger model execution encounters the branch-once block. If it is encountered again, the trigger model ignores the block and continues in the normal sequence.The once block is reset when trigger model execution reaches the idle state. Therefore, the branch-once block always executes the first time the trigger model execution encounters this block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model first encounters this block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE, 4);", - "description": "When the trigger model reaches block 2, the trigger model goes to block 4 instead of going in the default sequence of block 3.\n" - } - ], - "related_commands": [ - "Once block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE_EXCLUDED", - "webhelpfile": "31109.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.", - "details": "The branch-once-excluded block is ignored the first time the trigger model encounters it. After the first encounter, the trigger model goes to the specified branching block.The branch-once-excluded block is reset when the trigger model starts or is placed in idle.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model encounters this block after the first encounter", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, 4);", - "description": "When the trigger model reaches block 2 the first time, the trigger model goes to block 3. If the trigger model reaches this block again, the trigger model goes to block 4.\n" - } - ], - "related_commands": [ - "Once excluded block" - ] - }, - { - "name": " trigger.BLOCK_NOTIFY", - "webhelpfile": "31110.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that generates a trigger event and immediately continues to the next block.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "The identification number of the notification; 1 to 8", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.model.setblock(5, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY2);trigger.digout[3].stimulus = trigger.EVENT_NOTIFY2;", - "description": "Define trigger model block 5 to be the notify 2 event. Assign the notify 2 event to be the stimulus for digital output line 3.\n" - } - ], - "related_commands": [ - "Notify block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ALWAYS", - "webhelpfile": "31112.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that always goes to a specific block.", - "details": "When the trigger model reaches a branch-always building block, it goes to the building block set by branchToBlock.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number to execute when the trigger model reaches the Branch Always block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ALWAYS, 20);", - "description": "When the trigger model reaches block 6, always branch to block 20.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_DYNAMIC", - "webhelpfile": "31114.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.", - "details": "The measure/digitize block must occur in the trigger model before the branch-on-dynamic-limits block. If no block is defined, the measurement from the previous measure/digitize block is used. If no previous measure/digitize block exists, an error is reported.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_DYNAMIClimitType", - "range": "" - }, - { - "name": "limitNumber", - "description": "The limit number (1 or 2)", - "enum": "", - "type": "1|2", - "range": "(1 or 2)" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the criteria set in the configuration list", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, trigger.LIMIT_OUTSIDE, 2, 10, 5);", - "description": "Configure block 7 to check if limit 2 is outside its limit values, based on the measurements made in block 5. If values are outside the measurements, branch to block 10. If the values are not outside the measurements, trigger model execution continues to block 8.\n" - } - ], - "related_commands": [ - "Dynamic Limit block", - "smu.measure.limit[Y].low.value", - "smu.measure.limit[Y].high.value" - ] - }, - { - "name": " trigger.BLOCK_DELAY_CONSTANT", - "webhelpfile": "31347.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a constant delay to the execution of a trigger model.", - "details": "When trigger model execution reaches a delay block, it stops normal measurement and trigger model operation for the time set by the delay. Background measurements continue to be made, and if any previously executed block started infinite measurements, they also continue to be made.If other delays have been set, this delay is in addition to the other delays.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "time", - "description": "The amount of time to delay in seconds (167 ns to 10 ks, or 0 for no delay)", - "enum": "", - "type": "number", - "range": "(167 ns to 10 ks, or 0 for no delay)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_DELAY_CONSTANT, 30e-3);", - "description": "Configure trigger block 7 to delay the trigger model before the next block until a delay of 30 ms elapses.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digin[N].edge", - "webhelpfile": "31360.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the edge used by the trigger event detector on the given trigger line.", - "details": "This command sets the logic on which the trigger event detector and the output trigger generator operate on the specified trigger line.To directly control the line state, set the mode of the line to digital and use the write command. When the digital line mode is set for open drain, the edge settings assert a TTL low-pulse.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger logic value", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggerdiginedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "detectedEdge = trigger.digin[N].edge", - "trigger.digin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;trigger.digin[4].edge = trigger.EDGE_RISING;", - "description": "Sets the trigger mode for digital I/O line\u00a04 to detect a rising-edge trigger as an input.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "digio.writeport()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "digio.line[N].mode", - "webhelpfile": "31363.htm", - "signature": "", - "command_return": "lineMode", - "type": "Attribute (RW)", - "default_value": "digio.MODE_DIGITAL_IN\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode of the digital I/O line to be a digital line, trigger line, or synchronous line and sets the line to be input, output, or open-drain.", - "details": "", - "param_info": [ - { - "name": "lineMode", - "description": "The digital line control type and line mode", - "enum": "digio.MODE_DIGITAL_IN nil|digio.MODE_DIGITAL_OUT nil|digio.MODE_DIGITAL_OPEN_DRAIN nil|digio.MODE_TRIGGER_IN nil|digio.MODE_TRIGGER_OUT nil|digio.MODE_TRIGGER_OPEN_DRAIN nil|digio.MODE_SYNCHRONOUS_MASTER nil|digio.MODE_SYNCHRONOUS_ACCEPTOR nil", - "type": "digiolinemodelineMode", - "range": "" - }, - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "lineMode = digio.line[N].mode", - "digio.line[N].mode = lineMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_TRIGGER_OUT;", - "description": "Set digital I/O line 1 to be an output trigger line.\n" - } - ], - "related_commands": [ - "trigger.digin[N].edge" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "31368.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the digital I/O port. The least significant bit (bit B1) of the binary number corresponds to digital I/O line 1; bit B6 corresponds to digital I/O line 6.For example, a returned value of 42 has a binary equivalent of 101010, which indicates that lines 2, 4, 6 are high (1), and the other lines are low (0).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, and 6 are set high when the I/O port is read.\n--- --Output:\n--- --42\n--- --This is binary 101010\n" - } - ], - "related_commands": [ - "digio.writeport()" - ] - }, - { - "name": "trigger.digin[N].clear()", - "webhelpfile": "31373.htm", - "signature": "trigger.digin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital input line.", - "details": "The event detector of a trigger enters the detected state when an event is detected. For the specified trigger line, this command clears the event detector, discards the history, and clears the overrun status(sets the overrun status to false).", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.digin[2].clear();", - "description": "Clears the trigger event detector on I/O line\u00a02.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digin[N].wait()" - ] - }, - { - "name": "trigger.digin[N].overrun", - "webhelpfile": "31378.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "overrun = trigger.digin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.digin[1].overrun;print(overrun);", - "description": "If there is no trigger overrun on digital input\u00a01, the output is:\n--- --false\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].pulsewidth", - "webhelpfile": "31385.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0us)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use trigger.digout[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "width = trigger.digout[N].pulsewidth", - "trigger.digout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digout[N].assert()", - "trigger.digout[N].release()" - ] - }, - { - "name": "trigger.digout[N].assert()", - "webhelpfile": "31392.htm", - "signature": "trigger.digout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines.", - "details": "Initiates a trigger event and does not wait for completion. The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].pulsewidth = 20e-6;trigger.digout[2].assert();", - "description": "Asserts a trigger on digital I/O line 2 with a pulse width of 20\u00a0us.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "digio.line[N].reset()", - "webhelpfile": "31393.htm", - "signature": "digio.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets digital I/O line values to their factory defaults.", - "details": "This function resets the following attributes to their default values:It also clears trigger.digin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "digio.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "-- Set the digital I/O trigger line 3 for a falling edge;digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.digout[3].logic = trigger.LOGIC_NEGATIVE;-- Set the digital I/O trigger line 3 to have a pulsewidth of 50 microseconds.;trigger.digout[3].pulsewidth = 50e-6;-- Use digital I/O line 5 to trigger the event on line 3.;trigger.digout[3].stimulus = trigger.EVENT_DIGIO5;-- Print configuration (before reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);-- Reset the line back to factory default values.;digio.line[3].reset();-- Print configuration (after reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);", - "description": "Output before reset:\n--- --digio.MODE_TRIGGER_OUT 5e-05 trigger.EVENT_DIGIO5\n--- --\u00a0\n--- --Output after reset:\n--- --digio.MODE_TRIGGER_IN 1e-05 trigger.EVENT_NONE\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digout[N].pulsewidth", - "trigger.digout[N].stimulus" - ] - }, - { - "name": "trigger.digin[N].wait()", - "webhelpfile": "31394.htm", - "signature": "trigger.digin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time trigger.digin[N].wait() or trigger.digin[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and is ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detected", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.digin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;triggered = trigger.digin[4].wait(3);print(triggered);", - "description": "Waits up to 3 s for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].release()", - "webhelpfile": "31395.htm", - "signature": "trigger.digout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].assert()", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "trigger.lanout[N].assert()", - "webhelpfile": "31396.htm", - "signature": "trigger.lanout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].assert();", - "description": "Creates a trigger with LAN trigger 5.\n" - } - ], - "related_commands": [ - "lan.lxidomain", - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].wait()", - "webhelpfile": "31397.htm", - "signature": "trigger.lanin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time trigger.lanin[N].wait() or trigger.lanin[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.lanin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.lanin[5].wait(3);", - "description": "Wait for a trigger event with LAN trigger 5 with a timeout of 3\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].clear()", - "webhelpfile": "31398.htm", - "signature": "trigger.lanin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[5].clear();", - "description": "Clears the event detector with LAN event trigger 5.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun" - ] - }, - { - "name": "trigger.lanout[N].connect()", - "webhelpfile": "31401.htm", - "signature": "trigger.lanout[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;trigger.lanout[1].connect();trigger.lanout[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].disconnect()", - "webhelpfile": "31404.htm", - "signature": "trigger.lanout[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger event generator.", - "details": "When this command is set for TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].disconnect()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].connected", - "webhelpfile": "31406.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN event connection state.", - "details": "This is set to true when the LAN trigger is connected and ready to send trigger events after a successful trigger.lanout[N].connect() command. If the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attribute is changed or when the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = trigger.lanout[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;print(trigger.lanout[1].connected);", - "description": "Outputs true if connected, or false if not connected.\n--- --Example output:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].ipaddress", - "webhelpfile": "31409.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted-decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.After you change this setting, you must send the connect command before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = trigger.lanout[N].ipaddress", - "trigger.lanout[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[3].protocol = lan.PROTOCOL_TCP;trigger.lanout[3].ipaddress = \"192.0.32.10\";trigger.lanout[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be TCP when sending LAN triggers.\n--- --Use IP address \"192.0.32.10\" to connect the LAN trigger.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()" - ] - }, - { - "name": "trigger.lanin[N].overrun", - "webhelpfile": "31413.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.lanin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.lanin[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].protocol", - "webhelpfile": "31416.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "lan.PROTOCOL_TCP\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all the supported protocols. However, it uses the designated protocol for sending outgoing messages.After you change this setting, you must re-connect the LAN trigger event generator before you can send outgoing event messages.When multicast is selected, the trigger IP address is ignored, and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.PROTOCOL_TCP nil|lan.PROTOCOL_UDP nil|lan.PROTOCOL_MULTICAST nil", - "type": "triggerlanoutprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = trigger.lanout[N].protocol", - "trigger.lanout[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.lanout[1].protocol);", - "description": "Get LAN protocol that is being used for sending trigger messages for LAN event 1.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "trigger.lanout[N].stimulus", - "webhelpfile": "31419.htm", - "signature": "", - "command_return": "LANevent", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set the event to one of the existing trigger events, which are shown in the following table.Setting this attribute to none disables automatic trigger generation.If any events are detected before the trigger LAN connection is sent, the event is ignored, and the action overrun is set.", - "param_info": [ - { - "name": "LANevent", - "description": "The LAN event that causes this trigger to assert; see Details for values", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "LANevent = trigger.lanout[N].stimulus", - "trigger.lanout[N].stimulus = LANevent" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].stimulus = trigger.EVENT_TIMER1;", - "description": "Use the timer 1 trigger event as the source for LAN trigger 5 stimulus.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "smu.measure.userdelay[N]", - "webhelpfile": "31441.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay (0 for no delay, or 167\u00a0ns to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 for no delay, or 167\u00a0ns to 10 ks)" - }, - { - "name": "N", - "description": "The user delay to which this time applies (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The measurement function; see Functions", - "enum": "", - "type": "smumeasureuserdelayfunction", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.measure.userdelay[N]", - "smu.measure.userdelay[N] = delayTime", - "delayTime = smu.measure.getattribute(function, ATTR_MEAS_USER_DELAY_N)", - "smu.measure.setattribute(function, ATTR_MEAS_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for measure 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls measure user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "smu.measure.readwithtime()", - "webhelpfile": "31457.htm", - "signature": "smu.measure.readwithtime()", - "command_return": "reading, seconds, fractional", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates measurements and returns the last actual measurement and time information in UTC format without using the trigger model.", - "details": "This command initiates measurements using the present function setting, stores the readings in a reading buffer, and returns the last reading.The smu.measure.count attribute determines how many measurements are performed.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "seconds", - "description": "Seconds in UTC format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractional", - "description": "Fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading, seconds, fractional = smu.measure.readwithtime()", - "smu.measure.readwithtime(bufferName)" - ], - "overloads": [ - "smu.measure.readwithtime(bufferName)" - ], - "examples": [ - { - "example": "print(smu.measure.readwithtime(defbuffer1));", - "description": "Print the last measurement and time information from defbuffer1 in UTC format, which will look similar to:\n--- ---1.405293589829e-11 1400904629 0.1950935\n" - } - ], - "related_commands": [ - "smu.measure.count", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "smu.source.sweeplist()", - "webhelpfile": "31499.htm", - "signature": "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets up a sweep based on a configuration list, which allows you to customize the sweep.", - "details": "This command allows you to set up a custom sweep, using a configuration list to specify the source levels.When you specify a delay, a delay block is added to the sweep trigger model. This delay is added to any source delay you may have set. For example, if you set 10 ms for the source delay and 25 ms for the delay in the for the log sweep command, the actual delay is 35 ms.To run the sweep, initiate the trigger model.You cannot use a writable reading buffer to collect data from a sweep.", - "param_info": [ - { - "name": "configListName", - "description": "The name of the source configuration list that the sweep uses; this must be defined before sending this command", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list where the sweep starts; default is 1", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "sDelay", - "description": "The delay between measurement points; default is 0 for no delay or you can set a specific delay value from 50 us to 10 ks", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "count", - "description": "The number of times to run the sweep; default is 1", - "enum": "smu.INFINITE nil", - "type": "smusourcesweeplistcount | integer", - "range": "" - }, - { - "name": "failAbort", - "description": "Complete the sweep if the source limit is exceeded", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourcesweeplistfailAbort", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of a reading buffer; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort, bufferName)" - ], - "overloads": [ - "smu.source.sweeplist(configListName)", - "smu.source.sweeplist(configListName, index)", - "smu.source.sweeplist(configListName, index, sDelay)", - "smu.source.sweeplist(configListName, index, sDelay, count)", - "smu.source.sweeplist(configListName, index, sDelay, count, failAbort)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"CurrListSweep\");smu.source.func = smu.FUNC_DC_CURRENT;smu.source.range = 100e-3;smu.source.level = 1e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 10e-6;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 7e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 11e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.level = 9e-3;smu.source.configlist.store(\"CurrListSweep\");smu.source.sweeplist(\"CurrListSweep\", 1, 0.001);smu.measure.func = smu.FUNC_DC_VOLTAGE;smu.measure.range = 20;trigger.model.initiate();", - "description": "Reset the instrument to its defaults\n--- --Create a source configuration list called CurrListSweep.\n--- --Set the source function to current.\n--- --Set the source current range to 100\u00a0mA.\n--- --Set the source current level to 1\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 10\u00a0uA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 7\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 11\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set the source current level to 9\u00a0mA.\n--- --Save the source settings to CurrListSweep.\n--- --Set up a list sweep that uses the entries from the CurrListSweep configuration list and starts at index 1 of the list.\n--- --Set a source delay of 1\u00a0ms.\n--- --Start the sweep.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()" - ] - }, - { - "name": "status.questionable.setmap()", - "webhelpfile": "31612.htm", - "signature": "status.questionable.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function maps events to bits in the questionable event registers.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.questionable.setmap(bitNumber, setEvent)", - "status.questionable.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.questionable.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.questionable.setmap(0, 4917, 4918);", - "description": "When event 4917 (a default buffer is 0% filled) occurs, bit 0 is set in the condition register and the event register of the Questionable Event Register. When event 4918 (a default buffer is 100% filled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "status.questionable.getmap()" - ] - }, - { - "name": "status.questionable.getmap()", - "webhelpfile": "31613.htm", - "signature": "status.questionable.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Questionable Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - } - ], - "usage": [ - "setEvent, clearEvent = status.questionable.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.getmap(9));", - "description": "Returns the events that were mapped to set and clear bit 9.\n" - } - ], - "related_commands": [ - "Questionable Event Register", - "status.questionable.setmap()" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "31614.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Condition Register of the status model.", - "details": "This command reads the contents of the Questionable Condition Register, which is one of the Questionable Event Registers.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.condition);", - "description": "Reads the Questionable Condition Register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "31615.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the questionable event enable register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Questionable Event Register.When one of these bits is set, when the corresponding bit in the Questionable Event Register or Questionable Condition Register is set, the MSB and QSM bits in the Status Byte Register are set.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.enable", - "status.questionable.enable = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = 17;print(status.questionable.enable);", - "description": "Set bits 0 and 4 of the Questionable Event Enable Register.\n--- --Returns 17, which indicates the register was set correctly.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.condition", - "webhelpfile": "31635.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "You can use this command to read the status byte, which is returned as a numeric value. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence. The returned value can indicate that one or more status events occurred. If more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).The meanings of the individual bits of this register are shown in the following table.", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Example output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "31637.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the Operation Event Enable Register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Operation Event Register.When one of these bits is set, when the corresponding bit in the Operation Event Register or Operation Condition Register is set, the OSB bit in the Status Byte Register is set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.enable", - "status.operation.enable = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Sets the 12 and 14 bits of the operation status enable register using a decimal value.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "31638.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This attribute reads the operation event register of the status model.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.event" - ], - "overloads": [], - "examples": [ - { - "example": "status.request_enable = status.OSB ;status.operation.setmap(0, 4918, 4917);status.operation.enable = 1;defbuffer1.clear();defbuffer1.fillmode = buffer.FILL_ONCE;defbuffer1.capacity = 10;smu.measure.count = 10;smu.measure.read();print(status.operation.event);", - "description": "Set bits in the Status Request Enable Register to record an enabled event in the Operation Status Register.\n--- --Map event number 4918 (a default buffer is full) to set bit 0 in the Operation Event Register and event number 4917 (a default buffer is empty) to clear bit 0.\n--- --Clear defbuffer1.\n--- --Set defbuffer1 to fill once.\n--- --Resizes defbuffer1 to 10 readings. \n--- --Sets the measure count to 10 readings and makes a measurement. \n--- --Reads the operation event register.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "31639.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This command reads the contents of the Operation Condition Register, which is one of the Operation Event Registers.For detail on interpreting the value of a register, see Understanding bit settings.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.condition);", - "description": "Returns the contents of the register.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.setmap()", - "webhelpfile": "31648.htm", - "signature": "status.operation.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to map events to bits in the Operation Event Register.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.See Event numbers for information about event numbers.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.operation.setmap(bitNumber, setEvent)", - "status.operation.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.operation.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.operation.setmap(0, 2731, 2732);", - "description": "When event 2731 (trigger model initiated) occurs, bit 0 in the condition and event registers of the Operation Event Register are set. When event 2732 (trigger model idled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Event numbers", - "Operation Event Register", - "Programmable status register sets", - "status.operation.getmap()" - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "31653.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the contents of the Standard Event Status Register set of the status model.", - "details": "When this command returns zero (0), no bits are set. You can send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "standardRegister = status.standard.event" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.standard.event);", - "description": "May return the value 129, showing that the Standard Event Status Register contains binary 10000001\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "32386.htm", - "signature": "", - "command_return": "SRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the settings of the Service Request (SRQ) Enable Register.", - "details": "This command sets or clears the individual bits of the Status Request Enable Register.The Status Request Enable Register is cleared when power is cycled or when a parameter value of 0 is sent with this command.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "SRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings (0 to 255)", - "enum": "", - "type": "integer", - "range": "(SRQ)" - } - ], - "usage": [ - "SRQEnableRegister = status.request_enable", - "status.request_enable = SRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register and clear all other bits.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits and clear all other bits of the service request (SRQ) enable register.\n" - }, - { - "example": "status.request_enable = 0;", - "description": "Clear the register.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.gettime()", - "webhelpfile": "32416.htm", - "signature": "localnode.gettime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the instrument date and time.", - "details": "The time is returned in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "print(os.date('%c', gettime()))", - "description": "Example output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "print(os.date('%c', gettime()));", - "description": "Example output:\n--- --Tue Dec 5 03:44:37 2017\n" - } - ], - "related_commands": [ - "localnode.settime()" - ] - }, - { - "name": "tsplink.line[N].mode", - "webhelpfile": "32538.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "tsplink.MODE_DIGITAL_OPEN_DRAIN\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation of a TSP-Link line.", - "details": "This command defines whether or not the line is used as a digital or trigger control line and if it is an input or output.The line mode can be set to the following options:", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode; see Details", - "enum": "", - "type": "tsplinkLineMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.line[N].mode", - "tsplink.line[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;", - "description": "Sets the trigger mode for synchronization line 3 as a trigger open drain line.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkout[N].logic" - ] - }, - { - "name": "trigger.tsplinkin[N].edge", - "webhelpfile": "32539.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates which trigger edge controls the trigger event detector for a trigger line.", - "details": "When the edge is detected, the instrument asserts a TTL-low pulse for the output.The output state of the I/O line is controlled by the trigger logic. The user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger mode", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggertsplinkinedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "detectedEdge = trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[3].edge = trigger.EDGE_RISING;", - "description": "Sets synchronization line 3 to detect rising edge triggers as input.\n" - } - ], - "related_commands": [ - "digio.writeport()", - "tsplink.line[N].mode", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkout[N].logic", - "webhelpfile": "32540.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger output with output logic for a trigger line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggertsplinkoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "logicType = trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].logic = trigger.LOGIC_POSITIVE;", - "description": "Sets the trigger logic for synchronization line 3 to output a positive pulse.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].reset()", - "webhelpfile": "32541.htm", - "signature": "tsplink.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults.", - "details": "The tsplink.line[N].reset() function resets the following attributes to their default values:This also clears trigger.tsplinkin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes to default values.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].overrun", - "trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].stimulus", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].state", - "webhelpfile": "32542.htm", - "signature": "", - "command_return": "lineState", - "type": "Attribute (RW)", - "default_value": "tsplink.STATE_HIGH\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or writes the digital state of a TSP-Link synchronization line.", - "details": "Use tsplink.writeport() to write to all TSP-Link synchronization lines.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "lineState", - "description": "The state of the synchronization line", - "enum": "tsplink.STATE_LOW nil|tsplink.STATE_HIGH nil", - "type": "tsplinklinestatelineState", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "lineState = tsplink.line[N].state", - "tsplink.line[N].state = lineState" - ], - "overloads": [], - "examples": [ - { - "example": "lineState = tsplink.line[3].state;print(lineState);", - "description": "Assume line 3 is set high, and then the state is read.\n--- --Output:\n--- --tsplink.STATE_HIGH\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode", - "tsplink.writeport()" - ] - }, - { - "name": "trigger.tsplinkout[N].assert()", - "webhelpfile": "32549.htm", - "signature": "trigger.tsplinkout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding trigger event.", - "details": "Initiates a trigger event and does not wait for completion. The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].clear()", - "webhelpfile": "32551.htm", - "signature": "trigger.tsplinkin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. When this command is sent, the instrument:", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[2].clear();", - "description": "Clears the trigger event on TSP-Link line 2.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].overrun", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].overrun", - "webhelpfile": "32552.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = trigger.tsplinkin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkin[1].overrun);", - "description": "If an event on line 1 was ignored, displays true; if no additional event occurred, displays false.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.tsplinkout[N].pulsewidth", - "webhelpfile": "32553.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to 0 asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0.0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0.0 to 100 ks)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "trigger.tsplinkout[N].release()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].release()", - "webhelpfile": "32555.htm", - "signature": "trigger.tsplinkout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP-Link trigger line.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].stimulus", - "webhelpfile": "32558.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to trigger.EVENT_NONE.Do not use this attribute when triggering under script control. Use trigger.tsplinkout[N].assert() instead.The event parameters that you can use are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event identifier for the triggering event (see Details)", - "enum": "", - "type": "triggerEvents", - "range": "(see Details)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "event = trigger.tsplinkout[N].stimulus", - "trigger.tsplinkout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkout[3].stimulus);", - "description": "Outputs the event that will start action on TSP-Link trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkin[N].wait()", - "webhelpfile": "32561.htm", - "signature": "trigger.tsplinkin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events are detected since the last time this command or trigger.tsplinkin[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.tsplinkin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;triggered = trigger.tsplinkin[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on TSP-Link line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].clear()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "32565.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node.", - "details": "This attribute returns the node number of the master in a set of instruments connected using TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "localnode.version", - "webhelpfile": "32595.htm", - "signature": "", - "command_return": "version", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware version of the instrument.", - "details": "This attribute indicates the version number of the firmware that is presently running in the instrument.", - "param_info": [ - { - "name": "version", - "description": "Instrument version level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "version = localnode.version" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.version);", - "description": "Outputs the present version level. Example output:\n--- --1.0.0a\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "32597.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the instrument's serial number.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT2, \"Serial #: \" ..localnode.serialno);display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clears the instrument display.\n--- --Places the serial number of this instrument on the bottom line of the USER swipe screen display. Displays the USER swipe screen.\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.version" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "32628.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "The instrument automatically detects the power line frequency when the instrument is powered on. Power line frequency can be 50\u00a0Hz or 60\u00a0Hz.", - "param_info": [ - { - "name": "frequency", - "description": "The detected line frequency", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;print(frequency);", - "description": "Reads the line frequency setting.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "32684.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.runscript(myConnection, \"myTest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled myTest on the TSP-enabled instrument connected with myConnection.\n" - } - ], - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "smu.measure.configlist.size()", - "webhelpfile": "32926.htm", - "signature": "smu.measure.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the size (number of configuration indexes) of a measure configuration list.", - "details": "", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total count of indexes stored in the specified measure configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = smu.measure.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.configlist.size(\"testMeasList\"));", - "description": "Returns the number of configuration indexes in a measure configuration list named testMeasList.\n--- --Example output:\n--- --1\n" - } - ], - "related_commands": [ - "createconfigscript()", - "smu.measure.configlist.create()" - ] - }, - { - "name": "localnode.access", - "webhelpfile": "33140.htm", - "signature": "", - "command_return": "accessType", - "type": "Attribute (RW)", - "default_value": "localnode.ACCESS_FULL\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the type of access users have to the instrument through different interfaces.", - "details": "When access is set to full, the instrument accepts commands from any interface with no login or password.When access is set to exclusive, you must log out of one remote interface and log into another one to change interfaces. You do not need a password with this access.Protected access is similar to exclusive access, except that you must enter a password when logging\u00a0in.When the access is set to locked out, a password is required to change interfaces, including the front-panel interface.Under any access type, if a script is running on one remote interface when a command comes in from another remote interface, the command is ignored and the message \"FAILURE: A script is running, use ABORT to stop it\" is generated.", - "param_info": [ - { - "name": "accessType", - "description": "The type of access", - "enum": "localnode.ACCESS_FULL nil|localnode.ACCESS_EXCLUSIVE nil|localnode.ACCESS_PROTECTED nil|localnode.ACCESS_LOCKOUT nil", - "type": "localnodeaccessaccessType", - "range": "" - } - ], - "usage": [ - "accessType = localnode.access", - "localnode.access = accessType" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.access = localnode.ACCESS_LOCKOUT;login admin;logout;", - "description": "Set the instrument access to locked out.\n--- --Log into the interface using the default password.\n--- --Log out of the interface.\n" - } - ], - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "smu.source.autodelay", - "webhelpfile": "33143.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the automatic delay that occurs when the source is turned on.", - "details": "When autodelay is turned on, the actual delay that is set depends on the range.When source autodelay is on, if you set a source delay, the autodelay is turned off.", - "param_info": [ - { - "name": "state", - "description": "Disable the source auto delay", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaystate", - "range": "" - }, - { - "name": "sourceAutorange", - "description": "Disable automatic source range", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smusourceautodelaysourceAutorange", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceautodelayfunction", - "range": "" - } - ], - "usage": [ - "state = smu.source.autodelay", - "smu.source.autodelay = state", - "state = smu.source.getattribute(function, ATTR_SRC_DELAY_AUTO)", - "smu.source.setattribute(function, ATTR_SRC_DELAY_AUTO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.autodelay = smu.OFF;", - "description": "Turn off auto delay when current is being sourced.\n" - } - ], - "related_commands": [ - "smu.source.delay" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "33148.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.DISABLE\n", - "tsp_link": "No\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Do not generate prompts", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = localnode.ENABLE;", - "description": "Enable prompting.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "smu.source.configlist.recall()", - "webhelpfile": "33155.htm", - "signature": "smu.source.configlist.recall(listName, index, measureListName, measureIndex)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a specific configuration index in a specific source configuration list and an optional measure configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a specific source configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified source configuration list of that index.You can optionally specify a measure configuration list and index to recall with the source settings. If you do not specify a measure index, the measure index defaults to match the source index. Specify a source and measure list together with this command to allow the instrument to coordinate the application of the settings in the two lists appropriately. If you do not need have the application of the source and measure configuration lists coordinated, you can specify just the source configuration list with this command and use the smu.measure.configlist.recall() command to recall measure settings separately in your application.If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, event code 2790, \"Configuration list, error, does not exist\" is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. To see the settings that are recalled with an index, use the smu.source.configlist.query() command.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a source configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the source configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "measureListName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "measureIndex", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)", - "smu.source.configlist.recall(listName, index, measureListName, measureIndex)" - ], - "overloads": [ - "smu.source.configlist.recall(listName)", - "smu.source.configlist.recall(listName, index)", - "smu.source.configlist.recall(listName, index, measureListName)" - ], - "examples": [ - { - "example": "smu.source.configlist.recall(\"MySourceList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MySourceList.\n" - } - ], - "related_commands": [ - "smu.source.configlist.create()" - ] - }, - { - "name": "trigger.lanout[N].logic", - "webhelpfile": "33157.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line.", - "details": "", - "param_info": [ - { - "name": "logicType", - "description": "The type of logic", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerlanoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "logicType = trigger.lanout[N].logic", - "trigger.lanout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[2].logic = trigger.LOGIC_POSITIVE;", - "description": "Set the logic for LAN trigger line 2 to positive.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digout[N].logic", - "webhelpfile": "33159.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the output logic of the trigger event generator to positive or negative for the specified line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerdigoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "logicType = trigger.digout[N].logic", - "trigger.digout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].logic = trigger.LOGIC_NEGATIVE;", - "description": "Sets line 4 mode to be a trigger output and sets the output logic of the trigger event generator to negative (asserts a low pulse).\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "33164.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This command is not available if the buffer style is set to compact.This read-only attribute is an array of status values for the readings in the buffer. The status values are floating-point numbers that encode the status value. Refer to the following table for values.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired; refer to Details", - "enum": "", - "type": "bufferVarstatuses", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.statuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --64, 64\n--- --Indicating that the status is buffer.STAT_LIMIT1_LOW.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.delete()", - "bufferVar.clear()", - "bufferVar.sourcestatuses", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "33260.htm", - "signature": "display.prompt(buttonID, promptText)", - "command_return": "promptID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an interactive dialog prompt that displays a custom message on the front-panel display.", - "details": "This command displays buttons and text on the front panel. You can set up scripts that respond to the buttons when they are selected.If you send display.BUTTONS_NONE, the operator needs to press the EXIT key to clear the message from the front-panel display. You can also use the display.delete() command to remove the prompt.Only one prompt can be active at a time.When the user presses a button, the button presses are returned as one of the following options:To capture return values, you need to use display.waitevent() to wait for the user button selection.", - "param_info": [ - { - "name": "promptID", - "description": "A set of characters that identifies the prompt; up to 63 characters", - "enum": "", - "type": "promptID", - "range": "" - }, - { - "name": "buttonID", - "description": "The type of prompt to display; choose one of the following options", - "enum": "display.BUTTONS_NONE nil|display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displaypromptbuttonID", - "range": "" - }, - { - "name": "promptText", - "description": "A string that contains the text that is displayed above the prompts", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "promptID = display.prompt(buttonID, promptText)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.delete()", - "display.waitevent()" - ] - }, - { - "name": "display.waitevent()", - "webhelpfile": "33261.htm", - "signature": "display.waitevent(timeout)", - "command_return": "objectID, subID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to wait for a user to respond to a prompt that was created with a prompt command.", - "details": "This command waits until a user responds to a front-panel prompt that was created with the display.prompt() command.", - "param_info": [ - { - "name": "objectID", - "description": "A number that identifies the object, such as a prompt message, that is displayed on the front panel", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "subID", - "description": "The returned value after a button is pressed on the front panel", - "enum": "display.BUTTON_YES nil|display.BUTTON_NO nil|display.BUTTON_OK nil|display.BUTTON_CANCEL nil", - "type": "displaywaiteventsubID", - "range": "" - }, - { - "name": "timeout", - "description": "The amount of time to wait before timing out; time is 0 to 300 s, where the default of 0 waits indefinitely", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "objectID, subID = display.waitevent()", - "objectID, subID = display.waitevent(timeout)" - ], - "overloads": [ - "objectID, subID = display.waitevent()" - ], - "examples": [ - { - "example": "smu.source.sweeplinear(\"test\", 1, 10, 10);display.prompt(display.BUTTONS_YESNO, \"Would you like to start the sweep now?\") ;sweepTest, result = display.waitevent();if result == display.BUTTON_YES then; trigger.model.initiate() ;end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a linear sweep.\n--- --Display the prompt \"Would you like to start the sweep now?\"\n--- --If the user presses Yes, the sweep starts.\n--- --If the user presses No, the sweep does not start, and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.input.prompt()", - "display.prompt()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "33286.htm", - "signature": "script.load(file)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The name that is used for scriptVar must not already exist as a global variable. In addition, the scriptVar name must be a global reference and not a local variable, table, or array.For external scripts, the root folder of the USB flash drive has the absolute path /usb1/.", - "param_info": [ - { - "name": "file", - "description": "A string that contains the path and file name of the script file to load; if scriptVar is not defined, this name is used as the global variable name for this script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The created script; a global variable with this name is used to reference the script", - "enum": "", - "type": "scriptVar", - "range": "" - } - ], - "usage": [ - "script.load(file)", - "scriptVar = script.load(file)" - ], - "overloads": [ - "script.load(file)" - ], - "examples": [ - { - "example": "test8 = script.load(\"/usb1/testSetup.tsp\");", - "description": "Loads the script with the file name testSetup.tsp that is on the USB flash drive and names it test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.catalog()", - "webhelpfile": "33290.htm", - "signature": "for name in script.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script returned from script.catalog()", - "enum": "", - "type": "any", - "range": "()" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the return names from the catalog command", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "for name in script.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n--- --print(name) represent the body parameter shown in the Usage.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "33394.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from the run-time memory and nonvolatile memory.", - "details": "When a script is deleted, the global variable referring to this script is also deleted.You must delete an existing script before you can use the name of that script again. Scripts are not automatically overwritten.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory and the global variable named test8.\n" - } - ], - "related_commands": [ - "Deleting a user script using a remote interface", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "33395.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source code of a script.", - "details": "The body of the script is a single string with lines separated by the new line character.", - "param_info": [ - { - "name": "code", - "description": "The body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source" - ], - "overloads": [], - "examples": [ - { - "example": "print(test7.source);", - "description": "Assuming a script named test7 was created on the instrument, this example retrieves the source code.\n--- --Output:\n--- --reset()\n--- --display.settext(display.TEXT1, \"Text on line 1\")\n--- --display.settext(display.TEXT2, \"Text on line 2\")\n" - } - ], - "related_commands": [ - "scriptVar.save()" - ] - }, - { - "name": "display.lightstate", - "webhelpfile": "33459.htm", - "signature": "", - "command_return": "brightness", - "type": "Attribute (RW)", - "default_value": "display.STATE_LCD_50\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the light output level of the front-panel display.", - "details": "This command changes the light output of the front panel when a test requires different instrument illumination levels.The change in illumination is temporary. The normal backlight settings are restored after a power cycle. You can use this to reset a display that is already dimmed by the front-panel Backlight Dimmer.", - "param_info": [ - { - "name": "brightness", - "description": "The brightness of the display", - "enum": "display.STATE_LCD_100 nil|display.STATE_LCD_75 nil|display.STATE_LCD_50 nil|display.STATE_LCD_25 nil|display.STATE_LCD_OFF nil|display.STATE_BLACKOUT nil", - "type": "displaylightstatebrightness", - "range": "" - } - ], - "usage": [ - "brightness = display.lightstate", - "display.lightstate = brightness" - ], - "overloads": [], - "examples": [ - { - "example": "display.lightstate = display.STATE_LCD_50;", - "description": "Set the display brightness to 50%.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.preset()", - "webhelpfile": "33635.htm", - "signature": "status.preset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears the event registers and the enable registers for operation and questionable. It will not clear the Service Request Enable Register (*SRE) to Standard Request Enable Register (*ESE).Preset does not affect the event queue.The Standard Event Status Register is not affected by this command.", - "param_info": [ - { - "name": "status.preset()", - "description": "Resets the instrument status model.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.preset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.preset();", - "description": "Resets the instrument status model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "buffer.delete()", - "webhelpfile": "33981.htm", - "signature": "buffer.delete(bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a user-defined reading buffer.", - "details": "You cannot delete the default reading buffers, defbuffer1 and defbuffer2.After deleting the buffer, call collectgarbage() to reclaim the memory the buffer was using.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of a user-defined reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "buffer.delete(bufferName)" - ], - "overloads": [], - "examples": [ - { - "example": "buf400\u00a0= buffer.make(400);smu.measure.read(buf400);printbuffer(1, buf400.n, buf400.relativetimestamps);buffer.delete(buf400);collectgarbage();", - "description": "Create a 400-element reading buffer named buf400.\n--- --Make measurements and store the readings in buf400.\n--- --Print the relative timestamps for each reading in the buffer.\n--- --Example output, assuming five readings are stored in the buffer:\n--- --0, 0.412850017, 0.821640085, 1.230558058, 1.629523236\n--- --Delete buf400.\n--- --Use collectgarbage() to unallocate the buffer.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "printbuffer()" - ] - }, - { - "name": "trigger.timer[N].start.seconds", - "webhelpfile": "33984.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.seconds", - "trigger.timer[N].start.seconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.seconds = localnode.gettime() + 30;trigger.timer[1].enable = trigger.ON;", - "description": "Set the trigger timer to start 30 s from the time when the timer is enabled.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].start.fractionalseconds", - "webhelpfile": "33985.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the fractional seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time in fractional seconds (0 to <1 s)", - "enum": "", - "type": "number", - "range": "(0 to <1 s)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.fractionalseconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.fractionalseconds = 0.4;", - "description": "Set the trigger timer to start in 0.4\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].start.generate" - ] - }, - { - "name": "reset()", - "webhelpfile": "34054.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings and clears the buffers.", - "details": "The reset() command in its simplest form resets the entire TSP-enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use the node[N].reset() command. Also use the node[N].reset() command to reset an instrument on a subordinate node.When no value is specified for system, the default value is true.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error event.", - "param_info": [ - { - "name": "system", - "description": "If the node is the master, the entire system is reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error event is generated.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.sourcestatuses", - "webhelpfile": "34340.htm", - "signature": "bufferVar.sourcestatuses[N]", - "command_return": "statusInfo", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source status conditions of the instrument for the reading point.", - "details": "This buffer recall attribute holds an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value for each measurement made. See the following table for values.", - "param_info": [ - { - "name": "statusInfo", - "description": "The status value when reading N of the specified buffer was acquired; Source status values are", - "enum": "buffer.STAT_PROTECTION nil|buffer.STAT_READBACK nil|buffer.STAT_OVER_TEMP nil|buffer.STAT_LIMIT nil|buffer.STAT_SENSE nil|buffer.STAT_OUTPUT nil", - "type": "bufferVarsourcestatusesstatusInfo", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInfo = bufferVar.sourcestatuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.sourcestatuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Turn on the source output.\n--- --Print the source status for the readings in testData.\n--- --Output:\n--- --136, 136\n--- --Indicating that the status is buffer.STAT_READBACK and buffer.STAT_OUTPUT.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "buffer.delete()", - "print()", - "printbuffer()" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "34363.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP-enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "The termination type", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtermSequence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "34428.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event.Use none to disable the blender input.The event parameter may be any of the trigger events shown in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "triggerEvents[]", - "range": "" - }, - { - "name": "N", - "description": "An integer that represents the trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "buffer.clearstats()", - "webhelpfile": "34560.htm", - "signature": "buffer.clearstats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the statistical information associated with the specified buffer.", - "details": "This command clears the statistics without clearing the readings.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1 if not specified", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "buffer.clearstats()", - "buffer.clearstats(bufferVar)" - ], - "overloads": [ - "buffer.clearstats()" - ], - "examples": [ - { - "example": "buffer.clearstats();", - "description": "Clears statistics for defbuffer1.\n" - } - ], - "related_commands": [ - "buffer.getstats()" - ] - }, - { - "name": "createconfigscript()", - "webhelpfile": "34589.htm", - "signature": "createconfigscript(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a setup file that captures most of the present settings of the instrument.", - "details": "This function does not automatically overwrite existing scripts with the same name. If scriptName is set to the name of an existing script, an event message is returned. You must delete the existing script before using the same script name. This includes the autoexec script, which runs automatically when the instrument power is turned on. You can set scriptName to autoexec, but you must delete the existing autoexec script first using the script.delete(\"autoexec\") command.Once created, the script that contains the settings can be run and edited like any other script.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script that will be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "createconfigscript(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "createconfigscript(\"myConfigurationScript\");reset();myConfigurationScript();", - "description": "Capture the present settings of the instrument into a script named myConfigurationScript.\n--- --Reset the instrument.\n--- --Restore the settings stored in myConfigurationScript.\n" - } - ], - "related_commands": [ - "Saving setups", - "script.delete()" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "34629.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"admin\"\n", - "tsp_link": "No\n", - "description": "This attribute stores the instrument password.", - "details": "When the access to the instrument is set to protected or lockout, this is the password that is used to gain access.If you forget the password, you can reset the password to the default:You can also reset the password and the LAN settings from the rear panel by inserting a straightened paper clip into hole below LAN RESET.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the instrument password (maximum 30 characters)", - "enum": "", - "type": "string", - "range": "(maximum 30 characters)" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the password to N3wpa55w0rd.\n" - } - ], - "related_commands": [ - "localnode.access" - ] - }, - { - "name": "eventlog.post()", - "webhelpfile": "34730.htm", - "signature": "eventlog.post(message, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to post your own text to the event log.", - "details": "You can use this command to create your own event log entries and assign a severity level to them. This can be useful for debugging and status reporting.From the front panel, you must set the Log Warnings and Log Information options on to have the custom warning and information events placed into the event log.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "message", - "description": "String that contains the message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "The type of event; if no event is defined, defaults to eventlog.SEV_INFO", - "enum": "eventlog.SEV_INFO nil|eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil", - "type": "eventlogposteventType", - "range": "" - } - ], - "usage": [ - "eventlog.post(message)", - "eventlog.post(message, eventType)" - ], - "overloads": [ - "eventlog.post(message)" - ], - "examples": [ - { - "example": "eventlog.clear();eventlog.post(\"Results in \\018\", eventlog.SEV_ERROR);print(eventlog.next());", - "description": "Posts an event that states \"Results in \u03a9\".\n--- --Output:\n--- --1005 User: Results in \u03a9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.usbdriveexists()", - "webhelpfile": "34905.htm", - "signature": "file.usbdriveexists()", - "command_return": "driveInserted", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function detects if a USB flash drive is inserted into the front-panel USB port.", - "details": "You can call this command from a script to verify that a USB flash drive is inserted before attempting to write data to it.", - "param_info": [ - { - "name": "driveInserted", - "description": "0", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "driveInserted = file.usbdriveexists()" - ], - "overloads": [], - "examples": [ - { - "example": "local response;local xMax = 10;\u00a0;for x = 1, xMax do; -- Make xMax readings and store them in defbuffer1.; smu.measure.read();end;\u00a0;if (file.usbdriveexists() == 1) then ; response = display.BUTTON_YES;else; response = display.input.prompt(display.BUTTONS_YESNO, \"Insert a USB flash drive.\\nPress Yes to write data or No to not write data.\") ;end;\u00a0;if (response == display.BUTTON_YES) then; if (file.usbdriveexists() == 1) then ; FileNumber = file.open(\"/usb1/TenReadings.csv\", file.MODE_WRITE); file.write(FileNumber,\"Reading,Seconds\\n\");\u00a0; -- Print out the measured values in a two-column format.; print(\"\\nIteration:\\tReading:\\tTime:\\n\");\u00a0; for i = 1, xMax do; print(i, defbuffer1[i], defbuffer1.relativetimestamps[i]); file.write(FileNumber, string.format(\"%g, %g\\r\\n\",defbuffer1.readings[i], defbuffer1.relativetimestamps[i])); end; file.close(FileNumber); else; response = display.input.prompt(display.BUTTONS_OK,; \"No drive detected. Allow more time after inserting a drive.\") ; end;end;", - "description": "Make measurements.\n--- --Verify that a flash drive is inserted into the instrument.\n--- --If the flash drive is inserted, write the data to the flash drive.\n--- --Print data into a two-column format.\n--- --If the flash drive is not inserted after selecting Yes, another prompt is displayed.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.source.userdelay[N]", - "webhelpfile": "34973.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay in seconds (0 to 10 ks)", - "enum": "", - "type": "number[]", - "range": "(0 to 10 ks)" - }, - { - "name": "N", - "description": "The number that identifies this user delay (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = smu.source.userdelay[N]", - "smu.source.userdelay[N] = delayTime", - "delayTime = smu.source.getattribute(function, ATTR_SRC_USER_DELAY_N)", - "smu.source.setattribute(function, ATTR_SRC_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_SOURCE_OUTPUT, smu.ON);trigger.model.setblock(2, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_S1);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(4, trigger.BLOCK_SOURCE_OUTPUT, smu.OFF);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay for source 1 to 5 s.\n--- --Set trigger block 1 to turn the source output on.\n--- --Set trigger block 2 to a dynamic delay that calls source user delay 1.\n--- --Set trigger block 3 to make a measurement.\n--- --Set trigger block 4 to turn the source output off.\n--- --Set trigger block 5 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "35118.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to two) on which to wait", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n--- --Wait 3 s while checking if trigger blender 1 event has occurred.\n" - } - ], - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.model.load() - ConfigList", - "webhelpfile": "35126.htm", - "signature": "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that uses source and measure configuration lists.", - "details": "This trigger-model template incorporates a source configuration list and measure configuration list. You must set up the configuration lists before loading the trigger model. If the configuration lists change, you must resend this command.You can also set a delay and change the reading buffer.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "ConfigList", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "measureConfigList", - "description": "A string that contains the name of the measurement configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "sourceConfigList", - "description": "A string that contains the name of the source configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList)", - "trigger.model.load(ConfigList, measureConfigList, sourceConfigList, delay)" - ], - "examples": [ - { - "example": "reset();smu.source.configlist.create(\"SOURCE_LIST\");smu.measure.configlist.create(\"MEASURE_LIST\");smu.source.level = 1;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 1e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 5;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 10e-3;smu.measure.configlist.store(\"MEASURE_LIST\");smu.source.level = 10;smu.source.configlist.store(\"SOURCE_LIST\");smu.measure.range = 100e-3;smu.measure.configlist.store(\"MEASURE_LIST\");trigger.model.load(\"ConfigList\", \"MEASURE_LIST\", \"SOURCE_LIST\");trigger.model.initiate();", - "description": "Set up a source configuration list named SOURCE_LIST and a measurement configuration list named MEASURE_LIST. Load the configuration list trigger model, using these two configuration lists. Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - Empty", - "webhelpfile": "35127.htm", - "signature": "trigger.model.load(Empty)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger model.", - "details": "When you load this trigger-model template, any blocks that have been defined in the trigger model are cleared so the trigger model has no blocks defined.", - "param_info": [ - { - "name": "Empty", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "trigger.model.load(\"Empty\")print(trigger.model.getblocklist())", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Clear the trigger model to have no blocks defined.Output:EMPTY", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.load(Empty)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model to have no blocks defined.\n--- --Output:\n--- --EMPTY\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LogicTrigger", - "webhelpfile": "35128.htm", - "signature": "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a logic trigger through the digital I/O.", - "details": "This trigger model waits for a digital input event to occur, makes a measurement, and issues a notify event. The notify event asserts a digital output line.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "LogicTrigger", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "digInLine", - "description": "The digital input line (1 to 6); also, the event that the trigger model will wait on in block\u00a01", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "digOutLine", - "description": "The digital output line (1 to 6)", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLogicTriggerclear", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)" - ], - "examples": [ - { - "example": "trigger.model.load(\"LogicTrigger\", 1, 2, 10, 0.001, defbuffer1);", - "description": "Set up the template to use the digital in line and wait for a pulse from digital in line 1 to trigger measurements.\n--- --Pulse digital out line 2 when the measurement is complete.\n--- --Make 10 measurements, with a delay of 1\u00a0ms before each measurement.\n--- --Store the measurements in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.digout[N].logic" - ] - }, - { - "name": " trigger.BLOCK_LOG_EVENT", - "webhelpfile": "35428.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to log an event in the event log when the trigger model is running.", - "details": "Note that using this block too often in a trigger model could overflow the event log. It may also take away from the time needed to process more critical trigger model blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "eventNumber", - "description": "The event number", - "enum": "trigger.LOG_INFO nil|trigger.LOG_WARN nil|trigger.LOG_ERROR nil|trigger.LOG_WARN_ABORT nil", - "type": "triggermodelsetblocktriggerBLOCK_LOG_EVENTeventNumber", - "range": "" - }, - { - "name": "message", - "description": "A string up to 31 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_LOG_EVENT, trigger.LOG_INFO2, \"Trigger model complete.\");", - "description": "Set trigger model block 9 to log an event when the trigger model completes. In the event log, the message is:\n--- --TM #1 block #9 logged: Trigger model complete.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_NOP", - "webhelpfile": "35431.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a placeholder that performs no action in the trigger model; available only using remote commands.", - "details": "If you remove a trigger model block, you can use this block as a placeholder for the block number so that you do not need to renumber the other blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_NOP);", - "description": "Set block number 4 to be a no operation block.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.delete()", - "webhelpfile": "38977.htm", - "signature": "display.delete(promptID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to remove a prompt on the front-panel display that was created with display.prompt().", - "details": "You can use this command to remove the presently displayed prompt.", - "param_info": [ - { - "name": "promptID", - "description": "The identifier defined by display.prompt()", - "enum": "", - "type": "promptID", - "range": "()" - } - ], - "usage": [ - "display.delete(promptID)" - ], - "overloads": [], - "examples": [ - { - "example": "removePrompt3 = display.prompt(display.BUTTONS_NONE, \"This prompt will disappear in 3 seconds\");delay(3);display.delete(removePrompt3);", - "description": "This example displays a prompt that is automatically removed in three seconds.\n--- --\n" - } - ], - "related_commands": [ - "display.prompt()" - ] - }, - { - "name": "display.input.number()", - "webhelpfile": "40051.htm", - "signature": "display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)", - "command_return": "numberEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that requests a number from the user on the front-panel display.", - "details": "This command prompts the instrument operator to enter a value.The prompt is displayed until it has been responded to.", - "param_info": [ - { - "name": "numberEntered", - "description": "The number that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; can be up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "numberFormat", - "description": "The format of the displayed number", - "enum": "display.NFORMAT_INTEGER nil|display.NFORMAT_DECIMAL nil|display.NFORMAT_EXPONENT nil|display.NFORMAT_PREFIX nil", - "type": "displayinputnumbernumberFormat", - "range": "" - }, - { - "name": "defaultValue", - "description": "The value that is initially displayed in the displayed keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimumValue", - "description": "The lowest value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximumValue", - "description": "The highest value that can be entered", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)" - ], - "overloads": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)" - ], - "examples": [ - { - "example": "smu.source.func = smu.FUNC_DC_CURRENT;testcurrent = display.input.number(\"Enter a Test Current (0 to 1 A)\", display.NFORMAT_PREFIX, 0, 0, 1);smu.source.level = testcurrent;", - "description": "This example displays a number pad on the screen that defaults to 0 and allows entries from 0 to 1. The number that the operator enters is assigned to the source current level. If the operator enters a value outside of the range, an error message is displayed.\n--- --\n" - } - ], - "related_commands": [ - "display.input.option()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.option()", - "webhelpfile": "40052.htm", - "signature": "display.input.option(dialogTitle, buttonTitle1, ...)", - "command_return": "BUTTON_OPTIONn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an option dialog box with customizable buttons on the front-panel display.", - "details": "Buttons are created from top to bottom, left to right. If you have more than five buttons, they are placed into two columns.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "n", - "description": "The number of the button that is selected from the front-panel display; nil if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right", - "enum": "", - "type": "display_BUTTON_OPTIONs | nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "buttonTitle1", - "description": "A string that contains the name of the first button; up to 15 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "buttonTitle2", - "description": "A string that contains the name of the second button; up to 15 characters", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "buttonTitleN", - "description": "A string that contains the names of subsequent buttons, where N is a number from 3 to 10; you can define up to 10 buttons; each button can be up to 15 characters", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "BUTTON_OPTIONn = display.input.option(dialogTitle, buttonTitle1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "optionID = display.input.option(\"Select an option\", \"Apple\", \"Orange\", \"Papaya\", \"Pineapple\", \"Blueberry\", \"Banana\", \"Grapes\", \"Peach\", \"Apricot\", \"Guava\");print(optionID);", - "description": "This example displays the following dialog box:\n--- --\n--- --If the user selects Peach, the return is display.BUTTON_OPTION8.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.prompt()", - "webhelpfile": "40053.htm", - "signature": "display.input.prompt(buttonSet, dialogTitle)", - "command_return": "buttonReturn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that accepts a user response from the front-panel display.", - "details": "This command waits for a user response to the prompt. You can use the text to ask questions that can be used to configure your test.The prompt is displayed until it has been responded to by the user. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "buttonReturn", - "description": "Indicates which button was pressed", - "enum": "display.BUTTON_OK nil|display.BUTTON_CANCEL nil|display.BUTTON_YES nil|display.BUTTON_NO nil", - "type": "displayinputpromptbuttonReturn", - "range": "" - }, - { - "name": "buttonSet", - "description": "The set of buttons to display", - "enum": "display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displayinputpromptbuttonSet", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 63 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buttonReturn = display.input.prompt(buttonSet, dialogTitle)" - ], - "overloads": [], - "examples": [ - { - "example": "result = display.input.prompt(display.BUTTONS_YESNO, \"Do you want to display the graph screen?\");if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "This displays the prompt \"Do you want to display the graph screen?\" on the front-panel display:\n--- --\n--- -- If the operator selects Yes, the graph screen is displayed.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.string()" - ] - }, - { - "name": "display.input.string()", - "webhelpfile": "40054.htm", - "signature": "display.input.string(dialogTitle, textFormat)", - "command_return": "textEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a dialog box that requests text from the user through the front-panel display.", - "details": "This command creates a prompt to the instrument operator to enter a string value.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "textEntered", - "description": "The text that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "textFormat", - "description": "The format of the entered text", - "enum": "display.SFORMAT_ANY nil|display.SFORMAT_UPPER_LOWER nil|display.SFORMAT_UPPER nil|display.SFORMAT_BUFFER_NAME nil", - "type": "displayinputstringtextFormat", - "range": "" - } - ], - "usage": [ - "textEntered = display.input.string(dialogTitle)", - "textEntered = display.input.string(dialogTitle, textFormat)" - ], - "overloads": [ - "textEntered = display.input.string(dialogTitle)" - ], - "examples": [ - { - "example": "value = display.input.string(\"Enter Test Name\", display.SFORMAT_ANY);print(value);", - "description": "This example displays the prompt \"Enter Test Name\" and a keyboard that the operator can use to enter a response.\n--- --\n--- --The return is the response from the operator.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.prompt()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "40235.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.ENABLE\n", - "tsp_link": "No\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = localnode.DISABLE;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "smu.measure.limit[Y].audible", - "webhelpfile": "41684.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.AUDIBLE_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument beeper sounds when a limit test passes or fails.", - "details": "The tone and length of beeper cannot be adjusted.See smu.measure.limit[Y].fail for an example of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "When the beeper sounds", - "enum": "smu.AUDIBLE_NONE nil|smu.AUDIBLE_FAIL nil|smu.AUDIBLE_PASS nil", - "type": "smumeasurelimitaudiblestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasurelimitaudiblefunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.limit[Y].audible", - "smu.measure.limit[Y].audible = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y)", - "smu.measure.setattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "state;", - "description": "When the beeper sounds:\n--- --Never: smu.AUDIBLE_NONEOn test failure: smu.AUDIBLE_FAILOn test pass: smu.AUDIBL" - } - ], - "related_commands": [ - "smu.measure.limit[Y].enable" - ] - }, - { - "name": " trigger.BLOCK_RESET_BRANCH_COUNT", - "webhelpfile": "41689.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a block in the trigger model that resets a branch counter to 0.", - "details": "When the trigger model reaches the Counter Reset block, it resets the count of the specified Branch on Counter block to zero.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "counter", - "description": "The block number of the counter that is to be reset", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 5, 2);trigger.model.setblock(4, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 3, 2);trigger.model.setblock(6, trigger.BLOCK_RESET_BRANCH_COUNT, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and take 5 readings.\n--- --Delay a second.\n--- --Loop three more times back to block 2.\n--- --Reset block 3 to 0.\n--- --Start the trigger model and wait for measurements to complete.\n--- --Print the number of readings in the buffer.\n--- --Output:\n--- --15\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.load() - SimpleLoop", - "webhelpfile": "46034.htm", - "signature": "trigger.model.load(SimpleLoop, count, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes a specific number of measurements.", - "details": "This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the Count parameter.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger-model blocks in a list format.", - "param_info": [ - { - "name": "SimpleLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)", - "trigger.model.load(SimpleLoop, count, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT;smu.terminals = smu.TERMINALS_REAR;smu.measure.autorange = smu.ON;smu.measure.nplc = 1; ;-- Set up source function;smu.source.func = smu.FUNC_DC_VOLTAGE;smu.source.ilimit.level = 0.1;smu.source.level = 20;smu.source.delay = 0.1;smu.source.highc = smu.OFF; ;-- Turn on output and initiate readings;smu.source.output = smu.ON;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;\u00a0;-- Discharge the capacitor to 0 V and turn off the output;smu.source.level = 0;delay(2);smu.source.output = smu.OFF;", - "description": "This example uses the SimpleLoop trigger-model template to do a capacitor test. This example produces 200 readings that have output similar to the following example:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 8.5718931952528e-11\n--- --2 0.151875 1.6215984111057e-10\n--- --3 0.303727 1.5521139928865e-10\n--- --. . .\n--- --198 29.91579194 1.5521250951167e-10\n--- --199 30.067648716 1.4131290582142e-10\n--- --200 30.219497716 1.5521067764368e-10\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LoopUntilEvent", - "webhelpfile": "46040.htm", - "signature": "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements until the specified event occurs.", - "details": "The event constant is the event that ends infinite triggering or ends readings set to occur before the trigger and start post-trigger readings. The trigger model makes readings until it detects the event constant. After the event, it makes a finite number of readings, based on the setting of the trigger position.The position marks the location in the reading buffer where the trigger will occur. The position is set as a percentage of the buffer capacity. The buffer captures measurements until a trigger occurs. When the trigger occurs, the buffer retains the percentage of readings specified by the position, then captures remaining readings until 100\u00a0percent of the buffer is filled. For example, if this is set to 75 for a reading buffer that holds 10,000 readings, the trigger model makes 2500 readings after it detects the source event. There are 7500 pre-trigger readings and 2500 post-trigger readings.The instrument makes two sets of readings. The first set is made until the trigger event occurs. The second set is made after the trigger event occurs, up to the number of readings calculated by the position parameter.You cannot have the event constant set at none when you run this trigger-model template.The following table lists the options that are available for triggerEvent.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "LoopUntilEvent", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "triggerEvent", - "description": "The event that ends infinite triggering or readings set to occur before the trigger; see Details", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "position", - "description": "The number of readings to make in relation to the size of the reading buffer; enter as a percentage (0% to 100%)", - "enum": "", - "type": "number", - "range": "(0% to 100%)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block (default)", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLoopUntilEventclear", - "range": "(default)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;smu.measure.func = smu.FUNC_DC_CURRENT; ;-- Initiate readings;trigger.model.load(\"LoopUntilEvent\", trigger.EVENT_DISPLAY, 50);trigger.model.initiate();", - "description": "Reset the instrument.\n--- --Set the instrument to measure current.\n--- --Load the LoopUntilEvent trigger model to make measurements until the front panel trigger key is pressed, then continue to make measurements equal to 50% of the reading buffer size.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - GradeBinning", - "webhelpfile": "46058.htm", - "signature": "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a grading operation.", - "details": "This trigger-model template allows you to grade components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the pass pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "GradeBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 1; range 1 to 15; default is\u00a01", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 2; range 1 to 15; default is\u00a02", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 3; range 1 to 15; default is\u00a04", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 4; range 1 to 15; default is\u00a08", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have passed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - SortBinning", - "webhelpfile": "46066.htm", - "signature": "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a sorting operation.", - "details": "This trigger-model template allows you to sort components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the all fail pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "SortBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 1; range 1 to 15; default is 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 2; range 1 to 15; default is 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 3; range 1 to 15; default is 4", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 4; range 1 to 15; default is 8", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have failed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.extravalues", - "webhelpfile": "46323.htm", - "signature": "bufferVar.extravalues[N]", - "command_return": "extraValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the additional values in a reading buffer.", - "details": "This attribute contains an additional value, such as the extra value written to a writable buffer. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extravalue", - "description": "The extra values for readings", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraValue = bufferVar.extravalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.write.format()", - "webhelpfile": "46427.htm", - "signature": "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the units and number of digits of the readings that are written into the reading buffer.", - "details": "This command is valid when the buffer style is writable or full writable. When the buffer style is set to full writable, you can include an extra value.The format defines the units and the number of digits that are reported for the data. This command affects how the data is shown in the reading buffer and what is shown on the front-panel Home, Histogram, Reading Table, and Graph screens.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "units", - "description": "The units for the first measurement in the buffer index", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "bufferwriteformatunits", - "range": "" - }, - { - "name": "displayDigits", - "description": "The number of digits to use for the first measurement", - "enum": "buffer.DIGITS_3_5 nil|buffer.DIGITS_4_5 nil|buffer.DIGITS_5_5 nil|buffer.DIGITS_6_5 nil|buffer.DIGITS_7_5 nil|buffer.DIGITS_8_5 nil", - "type": "bufferwriteformatdisplayDigits", - "range": "" - }, - { - "name": "extraUnits", - "description": "The units for the second measurement in the buffer index; the selections are the same as units (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for units", - "enum": "", - "type": "bufferwriteformatunits", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "extraDigits", - "description": "The number of digits to use for the second measurement; the selections are the same as displayDigits (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for displayDigits", - "enum": "", - "type": "bufferwriteformatdisplayDigits", - "range": "(only valid for buffer style WRITABLE_FULL)" - } - ], - "usage": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)" - ], - "overloads": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1.0000000000e+00, Watt DC, 2.0000000000e+00, Watt DC, 3.0000000000e+00, Watt DC, 4.0000000000e+00, Watt DC, 5.0000000000e+00, Watt DC, 6.0000000000e+00, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.reading()" - ] - }, - { - "name": "buffer.write.reading()", - "webhelpfile": "46428.htm", - "signature": "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to write readings into the reading buffer.", - "details": "For buffers that are set to the writable buffer style:For buffers that are set to the full writable buffer style:This command writes the data you specify into a reading buffer. The reading buffer must be set to the writable or full writable style, which is set when you make the buffer.Data must be added in chronological order. If the time is not specified for a reading, it is set to one integer second after the last reading. As you write the data, the front-panel home screen updates and displays the reading you entered.The status parameter provides additional information about the reading. The options are shown in the following table.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "readingValue", - "description": "The first value that is recorded in the buffer index", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "extraValue", - "description": "A second value that is recorded in the buffer index (only valid for buffer style WRITABLE_FULL)", - "enum": "", - "type": "integer", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "seconds", - "description": "An integer that represents the seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractionalSeconds", - "description": "The portion of the time that represents the fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "status", - "description": "Additional information about the reading; see Details", - "enum": "", - "type": "readingStatus", - "range": "" - } - ], - "usage": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)" - ], - "overloads": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.startindex", - "webhelpfile": "56793.htm", - "signature": "bufferVar.startindex", - "command_return": "startIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the starting index in a reading buffer.", - "details": "Use this attribute to find the starting index in a reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Starting index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.startindex = startIndex " - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n" - } - ], - "related_commands": [ - "bufferVar.endindex", - "buffer.make()" - ] - }, - { - "name": "bufferVar.endindex", - "webhelpfile": "56794.htm", - "signature": "bufferVar.endindex", - "command_return": "endIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the last index in a reading buffer.", - "details": "Use this attribute to find the ending index in a reading buffer.", - "param_info": [ - { - "name": "endIndex", - "description": "Ending index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.endindex = endIndex" - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);smu.measure.count = 6;smu.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);smu.measure.read(test1);print(test1.startindex, test1.endindex);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n--- --Make six more measurements and store them in buffer test1.\n--- --Get the start index and end index of test1.\n--- --Output:\n--- --1, 12\n" - } - ], - "related_commands": [ - "bufferVar.startindex", - "buffer.make()" - ] - }, - { - "name": "trigger.model.pause()", - "webhelpfile": "72471.htm", - "signature": "trigger.model.pause()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function pauses a running trigger model.", - "details": "This command pauses the trigger model.To continue the trigger model, send the resume command.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.pause()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.resume()" - ] - }, - { - "name": "trigger.model.resume()", - "webhelpfile": "73512.htm", - "signature": "trigger.model.resume()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function continues a paused trigger model.", - "details": "This command continues running the trigger model operation if the trigger model was paused.", - "param_info": [ - { - "name": "reset()smu.measure.func = smu.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.resume()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smu.measure.func = smu.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.pause()" - ] - }, - { - "name": "buffer.math()", - "webhelpfile": "73595.htm", - "signature": "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to run a mathematical expression on a measurement. The expression is applied when the measurement is placed in the reading buffer.", - "details": "", - "param_info": [ - { - "name": "readingBuffer", - "description": "The name of the reading buffer; the reading buffer selected must be set to the style FULL", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "unit", - "description": "The units to be applied to the value generated by the expression", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "buffermathunit", - "range": "" - }, - { - "name": "constant0", - "description": "The constant to be used for c0 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant1", - "description": "The constant to be used for c1 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant2", - "description": "The constant to be used for c2 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant3", - "description": "The constant to be used for c3 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant4", - "description": "The constant to be used for c4 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant5", - "description": "The constant to be used for c5 in the expression", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)" - ], - "overloads": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)" - ], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;\u00a0;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);\u00a0;print(\"Extra value reading 1: \", mathExp.extravalues[1]);print(\"Extra value reading 2: \", mathExp.extravalues[2]);print(\"Extra value reading 3: \", mathExp.extravalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: 6.3863430578e-05\n--- --Reading: 6.7818055872e-05\n--- --Reading: 1.9871571784e-05\n--- --Extra value reading 1: 6.3863430578e-05\n--- --Extra value reading 2: 4.3310937031e-09\n--- --Extra value reading 3: 1.3476513655e-09\n" - } - ], - "related_commands": [ - "buffer.unit()" - ] - }, - { - "name": "buffer.unit()", - "webhelpfile": "76401.htm", - "signature": "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create up to three custom units of measure for use in buffers.", - "details": "You can use custom units of measures in buffer math and writable buffers.If you specify more than two characters, the additional characters are ignored. Some characters are converted to other symbols:This unit is reset when power is cycled. It is not affected by reset.", - "param_info": [ - { - "name": "UNIT_CUSTOMN", - "description": "Custom unit user can create, The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "bufferCustomUnit", - "range": "" - }, - { - "name": "N", - "description": "The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "unitOfMeasure", - "description": "A string that defines the custom unit; up to three characters; defaults are X for custom unit 1, Y for unit 2, and Z for unit 3", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.unit(buffer.UNIT_CUSTOM1, \"fb\") ;\u00a0;buffer.math(mathExp, buffer.UNIT_CUSTOM1, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading \"..x..\":\", smu.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);for x = 1, 3 do ; print(\"Extra value reading \"..x..\":\", mathExp.extravalues[x]);end;", - "description": "Instrument has terminals set to FRONT.\n--- --Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the customer 1 buffer unit to fb.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make 3 readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading 1: 0.00015611271869\n--- --Reading 2: 9.0539004907e-05\n--- --Reading 3: 0.30001141669554\n--- --Extra value reading 1: 0.00015611271869\n--- --Extra value reading 2: 1.4134290203e-08\n--- --Extra value reading 3: 1.0336562635e-08\n" - } - ], - "related_commands": [ - "buffer.math()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.extraformattedvalues", - "webhelpfile": "81089.htm", - "signature": "bufferVar.extraformattedvalues[N]", - "command_return": "extraFormat", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement and the unit of measure of the additional values in a reading buffer.", - "details": "This attribute contains the measurement and the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraFormat", - "description": "The measurement and unit of measure of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraFormat = bufferVar.extraformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(400, buffer.STYLE_FULL);smu.measure.func = smu.FUNC_DC_VOLTAGE;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", smu.measure.read(mathExp));end;display.changescreen(display.SCREEN_READING_TABLE);print(\"Extra value reading 1: \", mathExp.extraformattedvalues[1]);print(\"Extra value reading 2: \", mathExp.extraformattedvalues[2]);print(\"Extra value reading 3: \", mathExp.extraformattedvalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 400 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: \t7.1233589551e-06\n--- --Reading: \t7.1233080234e-06\n--- --Reading: \t7.2616603575e-06\n--- --Extra value reading 1: \t+7.1233590 u\n--- --Extra value reading 2: \t+50.741880 p\n--- --Extra value reading 3: \t+51.727043 p\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.extravalueunits", - "webhelpfile": "81090.htm", - "signature": "bufferVar.extravalueunits[N]", - "command_return": "extraUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of the additional values in a reading buffer.", - "details": "This attribute contains the unit of measure of an additional value. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraUnits", - "description": "The units of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraUnits = bufferVar.extravalueunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.extravalueunits);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and extra value units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.activebuffer", - "webhelpfile": "81840.htm", - "signature": "", - "command_return": "bufferName", - "type": "Attribute (RW)", - "default_value": "defbuffer1\n", - "tsp_link": "Yes\n", - "description": "This attribute determines which buffer is used for measurements that are displayed on the front panel.", - "details": "The buffer defined by this command is used to store measurements data and is shown in the reading buffer indicator on the home screen of the instrument.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of the buffer to make active", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferName = display.activebuffer", - "display.activebuffer = bufferName" - ], - "overloads": [], - "examples": [ - { - "example": "display.activebuffer = buffer2;", - "description": "Set the front panel to use buffer2 as the active reading buffer.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "buffer.save()", - "webhelpfile": "85101.htm", - "signature": "buffer.save(bufferVar, fileName, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves data from the specified reading buffer to a USB flash drive.", - "details": "The file name must specify the full path (including /usb1/). If included, the file extension must be set to .csv. If no file extension is specified, .csv is added.Examples of valid destination file names:The Model 2470 does not check for existing files when you save. Verify that you are using a unique name to avoid overwriting any existing CSV files on the flash drive.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Defines how date and time information from the buffer is saved in the file on the USB flash drive; the options are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersavetimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, timeFormat)", - "buffer.save(bufferVar, fileName, timeFormat, start, end)" - ], - "overloads": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, timeFormat)" - ], - "examples": [ - { - "example": "buffer.save(MyBuffer, \"/usb1/myData.csv\");", - "description": "Save all reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Save all readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(defbuffer1, \"/usb1/defbuf1data\", buffer.SAVE_RAW_TIME);", - "description": "Save readings and raw time stamps from defbuffer1 to a file named defbuf1data on the USB flash\u00a0drive.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.saveappend()" - ] - }, - { - "name": "smu.breakdownprotection", - "webhelpfile": "88445.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "smu.BREAKDOWN_OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute allows you to enable the breakdown protection in situations where the current may exceed the programmed current or the limit current value due to a breakdown condition.", - "details": "A more comprehensive method of testing components to specify the DUT breakdown voltage is to measure the actual component breakdown voltage. To do this on a 1000\u00a0V rated MOSFET, you need to switch the sourcing method to current and the limit voltage to 1100\u00a0V (higher than the highest expected breakdown voltage). Sourcing the value of the breakdown current permits the SMU to measure the actual breakdown voltage of the component, which occurs precisely when the SMU reaches the programmed source current. When this operating point is reached, a voltage measurement records the actual breakdown voltage of the component, after which the small source current used to find this breakdown voltage can be reduced to zero while waiting for the next component to test.\u00a0The entire test should be done quickly with the lowest possible breakdown current to limit device self-heating. When performing this test, if the breakdown protection is off, you may find that at the exact moment of component breakdown, the current may exceed the limit current value.\u00a0With the breakdown function on, the peak current is limited to VOUTPUT/500.", - "param_info": [ - { - "name": "setting", - "description": "The breakdown protection setting", - "enum": "smu.BREAKDOWN_AUTO nil|smu.BREAKDOWN_OFF nil|smu.BREAKDOWN_ON nil", - "type": "any", - "range": "" - } - ], - "usage": [ - "setting = smu.breakdownprotection", - "smu.breakdownprotection = setting" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.input.option(\"Breakdown Control\", \"Auto\", \"Always On\", \"Always Off\") ;\u00a0;if selection ~= nil then; if selection == display.BUTTON_OPTION1 then; smu.breakdownprotection = smu.BREAKDOWN_AUTO; elseif selection == display.BUTTON_OPTION2 then; smu.breakdownprotection = smu.BREAKDOWN_ON; elseif selection == display.BUTTON_OPTION3 then; smu.breakdownprotection = smu.BREAKDOWN_OFF; end;end;", - "description": "Display a prompt that allows the user to select which type of breakdown protection to set.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.continuous", - "webhelpfile": "88463.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "trigger.CONT_AUTO\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the trigger mode setting after bootup.", - "details": "Conditions must be valid before continuous measurements can start.When the restart parameter is selected, the instrument is placed in local mode, aborts any running scripts, and aborts any trigger models that are running. If the command is in a script, it is the last command that runs before the script is aborted. The restart parameter is not stored in nonvolatile memory, so it does not affect start up behavior.The off and automatic parameters are stored in nonvolatile memory, so they affect start up behavior.", - "param_info": [ - { - "name": "setting", - "description": "Do not start continuous measurements after boot", - "enum": "trigger.CONT_OFF nil|trigger.CONT_AUTO nil|trigger.CONT_RESTART nil", - "type": "triggercontinuoussetting", - "range": "" - } - ], - "usage": [ - "setting = trigger.continuous", - "trigger.continuous = setting" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.continuous = trigger.CONT_OFF;", - "description": "When the instrument starts up, the measurement method is set to idle.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.autorangerebound", - "webhelpfile": "88860.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument restores the measure range to match the limit range after making a measurement.", - "details": "When autorange rebound is enabled, it prevents the source from being limited to a value that is below the source limit. After an autoranged measurement is made, the measure range is restored to match the limit range once the autoranged measurement is complete. This ensures that the source does not limit at less than the full limit setting.", - "param_info": [ - { - "name": "state", - "description": "Do not restore the measurement range after each measurement", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smumeasureautorangereboundstate", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureautorangereboundfunction", - "range": "" - } - ], - "usage": [ - "state = smu.measure.autorangerebound", - "smu.measure.autorangerebound = state", - "state = smu.measure.getattribute(function, ATTR_MEAS_RANGE_REBOUND)", - "smu.measure.setattribute(function, ATTR_MEAS_RANGE_REBOUND, state)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.func = smu.FUNC_DC_CURRENT;smu.measure.autorange = smu.ON;smu.measure.autorangerebound = smu.ON;", - "description": "Set the measurement function to current.\n--- --Set the range to be set automatically.\n--- --Set the measure range to be automatically restored to match the source limit value after each measurement.\n" - } - ], - "related_commands": [ - "smu.measure.autorange" - ] - }, - { - "name": "smu.interlock.enable", - "webhelpfile": "88873.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "smu.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the output can be turned on when the interlock is not engaged.", - "details": "", - "param_info": [ - { - "name": "state", - "description": "Allow the output to be turned on when the interlock is not engaged", - "enum": "smu.OFF nil|smu.ON nil", - "type": "smuinterlockenablestate", - "range": "" - } - ], - "usage": [ - "state = smu.interlock.enable", - "smu.interlock.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "smu.interlock.enable = smu.ON;", - "description": "The source output is disabled unless the interlock is engaged.\n" - } - ], - "related_commands": [ - "smu.interlock.tripped" - ] - }, - { - "name": "available()", - "webhelpfile": "89066.htm", - "signature": "available(functionality)", - "command_return": "presence", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks for the presence of specific instrument functionality.", - "details": "", - "param_info": [ - { - "name": "presence", - "description": "If the functionality is present, returns true; if not, returns false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "functionality", - "description": "The functionality to check for", - "enum": "", - "type": "functionality", - "range": "" - } - ], - "usage": [ - "presence = available(functionality)" - ], - "overloads": [], - "examples": [ - { - "example": "print(available(gpib));", - "description": "Returns true if GPIB communications are available. Returns false if GPIB communications are not available.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "smu.measure.getattribute()", - "webhelpfile": "91266.htm", - "signature": "smu.measure.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuregetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to smu.measure.setattribute() for available settings", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "()" - } - ], - "usage": [ - "value = smu.measure.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_RANGE));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_NPLC));print(smu.measure.getattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_DIGITS));", - "description": "Retrieve the range, NPLC, and digits settings for the DC voltage function.\n--- --Example return:\n--- --0.02\n--- --1\n--- --smu.DIGITS_4_5\n" - } - ], - "related_commands": [ - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.measure.configlist.storefunc()", - "webhelpfile": "91273.htm", - "signature": "smu.measure.configlist.storefunc(listName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a measure function into a measure configuration list whether or not the function is active.", - "details": "You must create the configuration list before using this command.If index is not specified, the settings are stored to the next available index in the configuration list.", - "param_info": [ - { - "name": "listName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The measure function settings to save into the configuration list", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasureconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.measure.configlist.storefunc(listName, function)", - "smu.measure.configlist.storefunc(listName, function, index)" - ], - "overloads": [ - "smu.measure.configlist.storefunc(listName, function)" - ], - "examples": [ - { - "example": "smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);\u00a0;", - "description": "Create a measure configuration list named MyMeasList.\n--- --Store the attributes for the DC Voltage settings in index\u00a01.\n--- --\u00a0\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()", - "smu.measure.setattribute()" - ] - }, - { - "name": "smu.source.configlist.storefunc()", - "webhelpfile": "91274.htm", - "signature": "smu.source.configlist.storefunc(ConfigListName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a source function into a source configuration list whether or not the function is active.", - "details": "The configuration list must be created before you send this function.", - "param_info": [ - { - "name": "ConfigListName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The function to save into the configuration list", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourceconfigliststorefuncfunction", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "smu.source.configlist.storefunc(ConfigListName, function)", - "smu.source.configlist.storefunc(ConfigListName, function, index)" - ], - "overloads": [ - "smu.source.configlist.storefunc(ConfigListName, function)" - ], - "examples": [ - { - "example": "smu.source.configlist.create(\"sourcelist\");smu.source.configlist.storefunc(\"sourcelist\", smu.FUNC_DC_CURRENT);", - "description": "Create a configuration list named sourcelist.\n--- --Store the settings for the DC current source function into the configuration list in index 1.\n" - } - ], - "related_commands": [ - "smu.measure.configlist.create()" - ] - }, - { - "name": "smu.source.setattribute()", - "webhelpfile": "91275.htm", - "signature": "smu.source.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a source function whether or not the function is active.", - "details": "You can set the following parameters. The links in the list below link to the descriptions of the corresponding TSP command descriptions. The settings available for each parameter are the same as the settings for the TSP commands.The parameters you can set are:", - "param_info": [ - { - "name": "function", - "description": "The source function; set to one of the following values", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcesetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The parameter to be set; see Details", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "" - }, - { - "name": "value", - "description": "The function or setting value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.source.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_RANGE, 0.007);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY, 0.35);smu.source.setattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_LEVEL, 0.035);", - "description": "Sets the range, delay, and level settings for DC current, whether or not DC current is the active function.\n" - } - ], - "related_commands": [ - "smu.source.configlist.storefunc()", - "smu.source.getattribute()", - "" - ] - }, - { - "name": "smu.source.getattribute()", - "webhelpfile": "91276.htm", - "signature": "smu.source.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The source function", - "enum": "smu.FUNC_DC_CURRENT nil|smu.FUNC_DC_VOLTAGE nil", - "type": "smusourcegetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The setting of the attribute; refer to smu.source.setattribute() for the list of attributes", - "enum": "", - "type": "smuSourceGetSetAttributes", - "range": "()" - } - ], - "usage": [ - "value = smu.source.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(smu.source.getattribute(smu.FUNC_DC_CURRENT, smu.ATTR_SRC_DELAY));", - "description": "Retrieve the source delay setting for DC current.\n--- --Example return:\n--- --1.05e-07\n" - } - ], - "related_commands": [ - "smu.source.setattribute()" - ] - }, - { - "name": "smu.measure.setattribute()", - "webhelpfile": "91445.htm", - "signature": "smu.measure.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a measure function whether or not the function is active.", - "details": "The lists following the Example and Also See information show the attributes that are available for each function, with links to the descriptions of the corresponding TSP command descriptions. The options for each attribute are the same as the settings for the TSP commands.Limit 1 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_1Limit 1 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_1Limit 1 enable: smu.ATTR_MEAS_LIMIT_ENABLE_1Limit 1 fail: smu.ATTR_MEAS_LIMIT_FAIL_1Limit 1 high value: smu.ATTR_MEAS_LIMIT_HIGH_1Limit 1 low value: smu.ATTR_MEAS_LIMIT_LOW_1Limit 2 audible: smu.ATTR_MEAS_LIMIT_AUDIBLE_2Limit 2 auto clear: smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_2Limit 2 enable: smu.ATTR_MEAS_LIMIT_ENABLE_2Limit 2 fail: smu.ATTR_MEAS_LIMIT_FAIL_2Limit 2 high value: smu.ATTR_MEAS_LIMIT_HIGH_2Limit 2 low value: smu.ATTR_MEAS_LIMIT_LOW_2", - "param_info": [ - { - "name": "function", - "description": "The measurement function", - "enum": "smu.FUNC_DC_VOLTAGE nil|smu.FUNC_DC_CURRENT nil|smu.FUNC_RESISTANCE nil", - "type": "smumeasuresetattributefunction", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to Details and the tables following the examples", - "enum": "", - "type": "smuMeasuresetFunctionattribute", - "range": "" - }, - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "smu.measure.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_REL_LEVEL, 0.55);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_HIGH_1, 0.64);smu.measure.setattribute(smu.FUNC_DC_VOLTAGE, smu.ATTR_MEAS_LIMIT_LOW_1, 0.32);smu.measure.configlist.create(\"MyMeasList\");smu.measure.configlist.storefunc(\"MyMeasList\", smu.FUNC_DC_VOLTAGE);", - "description": "Configure the DC Voltage function settings for the relative offset level, limit 1 high value, and limit 1 low value whether or not DC Voltage is the active function.\n--- --Create a configuration list named MyMeasList.\n--- --Store the settings for the DC Voltage function in MyMeasList at index 1.\n" - } - ], - "related_commands": [ - "smu.measure.getattribute()" - ] - } - ] -} \ No newline at end of file diff --git a/data/2601B.json b/data/2601B.json deleted file mode 100644 index f572e99..0000000 --- a/data/2601B.json +++ /dev/null @@ -1,29402 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2602B.json b/data/2602B.json deleted file mode 100644 index 96a6b04..0000000 --- a/data/2602B.json +++ /dev/null @@ -1,37285 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smub.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmubdigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smub.digits", - "display.smub.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.smub.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmubmeasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.measure.func", - "display.smub.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smub.abort()", - "webhelpfile": "15088.htm", - "signature": "smub.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smub.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smub.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smub.CALSET_NOMINAL nil|smub.CALSET_FACTORY nil|smub.CALSET_DEFAULT nil|smub.CALSET_PREVIOUS nil", - "type": "smubcalrestorecalset", - "range": "" - } - ], - "usage": [ - "smub.cal.restore()", - "smub.cal.restore(calset)" - ], - "overloads": [ - "smub.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smub.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smub.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smub.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smub.cal.adjustdate", - "smub.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smub.cal.date", - "smub.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smub.cal.due", - "smub.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smub.CAL_AUTO nil|smub.CAL_POSITIVE nil|smub.CAL_NEGATIVE nil", - "type": "smubcalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smub.cal.polarity", - "smub.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smub.CALSTATE_LOCKED nil|smub.CALSTATE_CALIBRATING nil|smub.CALSTATE_UNLOCKED nil", - "type": "smubcalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smub.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smub.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smub.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smub.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smub.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smub.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smub.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smub.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smub.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smub.CONTACT_FAST nil|smub.CONTACT_MEDIUM nil|smub.CONTACT_SLOW nil", - "type": "smubcontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smub.contact.speed", - "smub.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smub.contact.threshold", - "smub.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smub.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smub.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smub.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smub.measure.analogfilter", - "smub.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangev", - "smub.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangei", - "smub.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smub.AUTOZERO_OFF nil|smub.AUTOZERO_ONCE nil|smub.AUTOZERO_AUTO nil", - "type": "smubmeasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smub.measure.autozero", - "smub.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubmeasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smub.measure.delay", - "smub.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smub.measure.delayfactor", - "smub.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smub.measure.filter.count", - "smub.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smub.FILTER_OFF nil|smub.FILTER_ON nil", - "type": "smubmeasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smub.measure.filter.enable", - "smub.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smub.FILTER_MOVING_AVG nil|smub.FILTER_REPEAT_AVG nil|smub.FILTER_MEDIAN nil", - "type": "smubmeasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smub.measure.filter.type", - "smub.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smub.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smub.measure.highcrangedelayfactor", - "smub.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smub.measure.interval", - "smub.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangev", - "smub.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangei", - "smub.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smub.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smub.measure.nplc", - "smub.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangev", - "smub.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangei", - "smub.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.v()", - "reading = smub.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.i()", - "reading = smub.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.r()", - "reading = smub.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.p()", - "reading = smub.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)", - "iReading, vReading = smub.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablev", - "smub.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablei", - "smub.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enabler", - "smub.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablep", - "smub.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelv", - "smub.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.leveli", - "smub.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelr", - "smub.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelp", - "smub.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smub.reset()", - "webhelpfile": "15136.htm", - "signature": "smub.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smub.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smub.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smub.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smub.SENSE_LOCAL nil|smub.SENSE_REMOTE nil|smub.SENSE_CALA nil", - "type": "smubsensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smub.sense", - "smub.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangev", - "smub.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangei", - "smub.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smub.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smub.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubsourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smub.source.delay", - "smub.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smub.source.func", - "smub.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smub.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smub.source.highc", - "smub.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.levelv", - "smub.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.leveli", - "smub.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangev", - "smub.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangei", - "smub.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimitv", - "smub.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimiti", - "smub.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smub.OUTPUT_NORMAL nil|smub.OUTPUT_ZERO nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smub.source.offmode", - "smub.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smub.OUTPUT_OFF nil|smub.OUTPUT_ON nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smub.source.output", - "smub.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smub.OE_NONE nil|smub.OE_OUTPUT_OFF nil", - "type": "smubsourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smub.source.outputenableaction", - "smub.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangev", - "smub.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangei", - "smub.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smub.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smub.SETTLE_SMOOTH nil|smub.SETTLE_FAST_RANGE nil|smub.SETTLE_FAST_POLARITY nil|smub.SETTLE_DIRECT_IRANGE nil|smub.SETTLE_SMOOTH_100NA nil|smub.SETTLE_FAST_ALL nil|smub.SETTLE_FAST_ nil", - "type": "smubsourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smub.source.settling", - "smub.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smub.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smub.source.sink", - "smub.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smub.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smub.trigger.arm.count", - "smub.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smub.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.arm.stimulus", - "smub.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smubtriggerARMED_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smub.trigger.autoclear", - "smub.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smub.trigger.count", - "smub.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smub.SOURCE_IDLE1 nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smub.trigger.endpulse.action", - "smub.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smub.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.endpulse.stimulus", - "smub.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smub.SOURCE_IDLE nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.endsweep.action", - "smub.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smubtriggerIDLE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smub.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil|smub.ASYNC nil", - "type": "smubtriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.measure.action", - "smub.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smub.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.measure.stimulus", - "smub.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerMEASURE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerPULSE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSOURCE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSWEEP_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smubtriggerSWEEPING_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.source.action", - "smub.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limitv", - "smub.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limiti", - "smub.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smub.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.source.stimulus", - "smub.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitv", - "smub.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limiti", - "smub.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitp", - "smub.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smub.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smub.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smub.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "smub.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smub.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smub.source.offfunc", - "smub.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.smub.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmublimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.limit.func", - "display.smub.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smub.measure.count", - "smub.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2604B.json b/data/2604B.json deleted file mode 100644 index 96a6b04..0000000 --- a/data/2604B.json +++ /dev/null @@ -1,37285 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smub.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmubdigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smub.digits", - "display.smub.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.smub.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmubmeasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.measure.func", - "display.smub.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smub.abort()", - "webhelpfile": "15088.htm", - "signature": "smub.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smub.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smub.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smub.CALSET_NOMINAL nil|smub.CALSET_FACTORY nil|smub.CALSET_DEFAULT nil|smub.CALSET_PREVIOUS nil", - "type": "smubcalrestorecalset", - "range": "" - } - ], - "usage": [ - "smub.cal.restore()", - "smub.cal.restore(calset)" - ], - "overloads": [ - "smub.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smub.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smub.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smub.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smub.cal.adjustdate", - "smub.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smub.cal.date", - "smub.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smub.cal.due", - "smub.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smub.CAL_AUTO nil|smub.CAL_POSITIVE nil|smub.CAL_NEGATIVE nil", - "type": "smubcalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smub.cal.polarity", - "smub.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smub.CALSTATE_LOCKED nil|smub.CALSTATE_CALIBRATING nil|smub.CALSTATE_UNLOCKED nil", - "type": "smubcalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smub.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smub.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smub.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smub.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smub.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smub.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smub.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smub.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smub.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smub.CONTACT_FAST nil|smub.CONTACT_MEDIUM nil|smub.CONTACT_SLOW nil", - "type": "smubcontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smub.contact.speed", - "smub.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smub.contact.threshold", - "smub.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smub.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smub.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smub.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smub.measure.analogfilter", - "smub.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangev", - "smub.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangei", - "smub.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smub.AUTOZERO_OFF nil|smub.AUTOZERO_ONCE nil|smub.AUTOZERO_AUTO nil", - "type": "smubmeasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smub.measure.autozero", - "smub.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubmeasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smub.measure.delay", - "smub.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smub.measure.delayfactor", - "smub.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smub.measure.filter.count", - "smub.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smub.FILTER_OFF nil|smub.FILTER_ON nil", - "type": "smubmeasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smub.measure.filter.enable", - "smub.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smub.FILTER_MOVING_AVG nil|smub.FILTER_REPEAT_AVG nil|smub.FILTER_MEDIAN nil", - "type": "smubmeasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smub.measure.filter.type", - "smub.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smub.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smub.measure.highcrangedelayfactor", - "smub.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smub.measure.interval", - "smub.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangev", - "smub.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangei", - "smub.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smub.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smub.measure.nplc", - "smub.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangev", - "smub.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangei", - "smub.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.v()", - "reading = smub.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.i()", - "reading = smub.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.r()", - "reading = smub.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.p()", - "reading = smub.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)", - "iReading, vReading = smub.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablev", - "smub.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablei", - "smub.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enabler", - "smub.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablep", - "smub.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelv", - "smub.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.leveli", - "smub.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelr", - "smub.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelp", - "smub.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smub.reset()", - "webhelpfile": "15136.htm", - "signature": "smub.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smub.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smub.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smub.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smub.SENSE_LOCAL nil|smub.SENSE_REMOTE nil|smub.SENSE_CALA nil", - "type": "smubsensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smub.sense", - "smub.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangev", - "smub.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangei", - "smub.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smub.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smub.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubsourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smub.source.delay", - "smub.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smub.source.func", - "smub.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smub.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smub.source.highc", - "smub.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.levelv", - "smub.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.leveli", - "smub.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangev", - "smub.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangei", - "smub.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimitv", - "smub.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimiti", - "smub.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smub.OUTPUT_NORMAL nil|smub.OUTPUT_ZERO nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smub.source.offmode", - "smub.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smub.OUTPUT_OFF nil|smub.OUTPUT_ON nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smub.source.output", - "smub.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smub.OE_NONE nil|smub.OE_OUTPUT_OFF nil", - "type": "smubsourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smub.source.outputenableaction", - "smub.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangev", - "smub.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangei", - "smub.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smub.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smub.SETTLE_SMOOTH nil|smub.SETTLE_FAST_RANGE nil|smub.SETTLE_FAST_POLARITY nil|smub.SETTLE_DIRECT_IRANGE nil|smub.SETTLE_SMOOTH_100NA nil|smub.SETTLE_FAST_ALL nil|smub.SETTLE_FAST_ nil", - "type": "smubsourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smub.source.settling", - "smub.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smub.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smub.source.sink", - "smub.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smub.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smub.trigger.arm.count", - "smub.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smub.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.arm.stimulus", - "smub.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smubtriggerARMED_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smub.trigger.autoclear", - "smub.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smub.trigger.count", - "smub.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smub.SOURCE_IDLE1 nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smub.trigger.endpulse.action", - "smub.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smub.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.endpulse.stimulus", - "smub.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smub.SOURCE_IDLE nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.endsweep.action", - "smub.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smubtriggerIDLE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smub.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil|smub.ASYNC nil", - "type": "smubtriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.measure.action", - "smub.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smub.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.measure.stimulus", - "smub.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerMEASURE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerPULSE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSOURCE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSWEEP_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smubtriggerSWEEPING_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.source.action", - "smub.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limitv", - "smub.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limiti", - "smub.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smub.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.source.stimulus", - "smub.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitv", - "smub.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limiti", - "smub.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitp", - "smub.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smub.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smub.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smub.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "smub.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smub.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smub.source.offfunc", - "smub.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.smub.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmublimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.limit.func", - "display.smub.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smub.measure.count", - "smub.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2611B.json b/data/2611B.json deleted file mode 100644 index f572e99..0000000 --- a/data/2611B.json +++ /dev/null @@ -1,29402 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2612B.json b/data/2612B.json deleted file mode 100644 index 96a6b04..0000000 --- a/data/2612B.json +++ /dev/null @@ -1,37285 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smub.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmubdigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smub.digits", - "display.smub.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.smub.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmubmeasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.measure.func", - "display.smub.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smub.abort()", - "webhelpfile": "15088.htm", - "signature": "smub.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smub.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smub.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smub.CALSET_NOMINAL nil|smub.CALSET_FACTORY nil|smub.CALSET_DEFAULT nil|smub.CALSET_PREVIOUS nil", - "type": "smubcalrestorecalset", - "range": "" - } - ], - "usage": [ - "smub.cal.restore()", - "smub.cal.restore(calset)" - ], - "overloads": [ - "smub.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smub.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smub.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smub.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smub.cal.adjustdate", - "smub.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smub.cal.date", - "smub.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smub.cal.due", - "smub.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smub.CAL_AUTO nil|smub.CAL_POSITIVE nil|smub.CAL_NEGATIVE nil", - "type": "smubcalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smub.cal.polarity", - "smub.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smub.CALSTATE_LOCKED nil|smub.CALSTATE_CALIBRATING nil|smub.CALSTATE_UNLOCKED nil", - "type": "smubcalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smub.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smub.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smub.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smub.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smub.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smub.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smub.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smub.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smub.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smub.CONTACT_FAST nil|smub.CONTACT_MEDIUM nil|smub.CONTACT_SLOW nil", - "type": "smubcontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smub.contact.speed", - "smub.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smub.contact.threshold", - "smub.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smub.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smub.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smub.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smub.measure.analogfilter", - "smub.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangev", - "smub.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangei", - "smub.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smub.AUTOZERO_OFF nil|smub.AUTOZERO_ONCE nil|smub.AUTOZERO_AUTO nil", - "type": "smubmeasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smub.measure.autozero", - "smub.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubmeasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smub.measure.delay", - "smub.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smub.measure.delayfactor", - "smub.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smub.measure.filter.count", - "smub.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smub.FILTER_OFF nil|smub.FILTER_ON nil", - "type": "smubmeasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smub.measure.filter.enable", - "smub.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smub.FILTER_MOVING_AVG nil|smub.FILTER_REPEAT_AVG nil|smub.FILTER_MEDIAN nil", - "type": "smubmeasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smub.measure.filter.type", - "smub.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smub.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smub.measure.highcrangedelayfactor", - "smub.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smub.measure.interval", - "smub.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangev", - "smub.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangei", - "smub.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smub.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smub.measure.nplc", - "smub.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangev", - "smub.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangei", - "smub.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.v()", - "reading = smub.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.i()", - "reading = smub.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.r()", - "reading = smub.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.p()", - "reading = smub.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)", - "iReading, vReading = smub.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablev", - "smub.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablei", - "smub.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enabler", - "smub.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablep", - "smub.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelv", - "smub.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.leveli", - "smub.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelr", - "smub.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelp", - "smub.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smub.reset()", - "webhelpfile": "15136.htm", - "signature": "smub.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smub.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smub.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smub.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smub.SENSE_LOCAL nil|smub.SENSE_REMOTE nil|smub.SENSE_CALA nil", - "type": "smubsensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smub.sense", - "smub.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangev", - "smub.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangei", - "smub.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smub.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smub.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubsourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smub.source.delay", - "smub.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smub.source.func", - "smub.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smub.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smub.source.highc", - "smub.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.levelv", - "smub.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.leveli", - "smub.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangev", - "smub.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangei", - "smub.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimitv", - "smub.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimiti", - "smub.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smub.OUTPUT_NORMAL nil|smub.OUTPUT_ZERO nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smub.source.offmode", - "smub.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smub.OUTPUT_OFF nil|smub.OUTPUT_ON nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smub.source.output", - "smub.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smub.OE_NONE nil|smub.OE_OUTPUT_OFF nil", - "type": "smubsourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smub.source.outputenableaction", - "smub.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangev", - "smub.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangei", - "smub.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smub.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smub.SETTLE_SMOOTH nil|smub.SETTLE_FAST_RANGE nil|smub.SETTLE_FAST_POLARITY nil|smub.SETTLE_DIRECT_IRANGE nil|smub.SETTLE_SMOOTH_100NA nil|smub.SETTLE_FAST_ALL nil|smub.SETTLE_FAST_ nil", - "type": "smubsourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smub.source.settling", - "smub.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smub.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smub.source.sink", - "smub.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smub.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smub.trigger.arm.count", - "smub.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smub.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.arm.stimulus", - "smub.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smubtriggerARMED_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smub.trigger.autoclear", - "smub.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smub.trigger.count", - "smub.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smub.SOURCE_IDLE1 nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smub.trigger.endpulse.action", - "smub.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smub.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.endpulse.stimulus", - "smub.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smub.SOURCE_IDLE nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.endsweep.action", - "smub.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smubtriggerIDLE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smub.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil|smub.ASYNC nil", - "type": "smubtriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.measure.action", - "smub.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smub.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.measure.stimulus", - "smub.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerMEASURE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerPULSE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSOURCE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSWEEP_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smubtriggerSWEEPING_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.source.action", - "smub.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limitv", - "smub.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limiti", - "smub.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smub.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.source.stimulus", - "smub.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitv", - "smub.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limiti", - "smub.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitp", - "smub.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smub.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smub.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smub.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "smub.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smub.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smub.source.offfunc", - "smub.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.smub.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmublimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.limit.func", - "display.smub.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smub.measure.count", - "smub.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2614B.json b/data/2614B.json deleted file mode 100644 index 96a6b04..0000000 --- a/data/2614B.json +++ /dev/null @@ -1,37285 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smub.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmubdigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smub.digits", - "display.smub.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.smub.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmubmeasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.measure.func", - "display.smub.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smub.abort()", - "webhelpfile": "15088.htm", - "signature": "smub.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smub.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smub.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smub.CALSET_NOMINAL nil|smub.CALSET_FACTORY nil|smub.CALSET_DEFAULT nil|smub.CALSET_PREVIOUS nil", - "type": "smubcalrestorecalset", - "range": "" - } - ], - "usage": [ - "smub.cal.restore()", - "smub.cal.restore(calset)" - ], - "overloads": [ - "smub.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smub.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smub.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smub.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smub.cal.adjustdate", - "smub.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smub.cal.date", - "smub.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smub.cal.due", - "smub.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smub.CAL_AUTO nil|smub.CAL_POSITIVE nil|smub.CAL_NEGATIVE nil", - "type": "smubcalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smub.cal.polarity", - "smub.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smub.CALSTATE_LOCKED nil|smub.CALSTATE_CALIBRATING nil|smub.CALSTATE_UNLOCKED nil", - "type": "smubcalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smub.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smub.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smub.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smub.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smub.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smub.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smub.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smub.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smub.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smub.CONTACT_FAST nil|smub.CONTACT_MEDIUM nil|smub.CONTACT_SLOW nil", - "type": "smubcontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smub.contact.speed", - "smub.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smub.contact.threshold", - "smub.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smub.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smub.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smub.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smub.measure.analogfilter", - "smub.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangev", - "smub.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangei", - "smub.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smub.AUTOZERO_OFF nil|smub.AUTOZERO_ONCE nil|smub.AUTOZERO_AUTO nil", - "type": "smubmeasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smub.measure.autozero", - "smub.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubmeasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smub.measure.delay", - "smub.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smub.measure.delayfactor", - "smub.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smub.measure.filter.count", - "smub.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smub.FILTER_OFF nil|smub.FILTER_ON nil", - "type": "smubmeasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smub.measure.filter.enable", - "smub.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smub.FILTER_MOVING_AVG nil|smub.FILTER_REPEAT_AVG nil|smub.FILTER_MEDIAN nil", - "type": "smubmeasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smub.measure.filter.type", - "smub.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smub.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smub.measure.highcrangedelayfactor", - "smub.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smub.measure.interval", - "smub.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangev", - "smub.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangei", - "smub.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smub.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smub.measure.nplc", - "smub.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangev", - "smub.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangei", - "smub.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.v()", - "reading = smub.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.i()", - "reading = smub.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.r()", - "reading = smub.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.p()", - "reading = smub.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)", - "iReading, vReading = smub.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablev", - "smub.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablei", - "smub.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enabler", - "smub.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablep", - "smub.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelv", - "smub.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.leveli", - "smub.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelr", - "smub.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelp", - "smub.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smub.reset()", - "webhelpfile": "15136.htm", - "signature": "smub.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smub.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smub.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smub.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smub.SENSE_LOCAL nil|smub.SENSE_REMOTE nil|smub.SENSE_CALA nil", - "type": "smubsensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smub.sense", - "smub.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangev", - "smub.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangei", - "smub.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smub.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smub.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubsourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smub.source.delay", - "smub.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smub.source.func", - "smub.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smub.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smub.source.highc", - "smub.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.levelv", - "smub.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.leveli", - "smub.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangev", - "smub.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangei", - "smub.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimitv", - "smub.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimiti", - "smub.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smub.OUTPUT_NORMAL nil|smub.OUTPUT_ZERO nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smub.source.offmode", - "smub.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smub.OUTPUT_OFF nil|smub.OUTPUT_ON nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smub.source.output", - "smub.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smub.OE_NONE nil|smub.OE_OUTPUT_OFF nil", - "type": "smubsourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smub.source.outputenableaction", - "smub.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangev", - "smub.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangei", - "smub.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smub.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smub.SETTLE_SMOOTH nil|smub.SETTLE_FAST_RANGE nil|smub.SETTLE_FAST_POLARITY nil|smub.SETTLE_DIRECT_IRANGE nil|smub.SETTLE_SMOOTH_100NA nil|smub.SETTLE_FAST_ALL nil|smub.SETTLE_FAST_ nil", - "type": "smubsourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smub.source.settling", - "smub.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smub.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smub.source.sink", - "smub.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smub.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smub.trigger.arm.count", - "smub.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smub.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.arm.stimulus", - "smub.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smubtriggerARMED_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smub.trigger.autoclear", - "smub.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smub.trigger.count", - "smub.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smub.SOURCE_IDLE1 nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smub.trigger.endpulse.action", - "smub.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smub.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.endpulse.stimulus", - "smub.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smub.SOURCE_IDLE nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.endsweep.action", - "smub.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smubtriggerIDLE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smub.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil|smub.ASYNC nil", - "type": "smubtriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.measure.action", - "smub.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smub.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.measure.stimulus", - "smub.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerMEASURE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerPULSE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSOURCE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSWEEP_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smubtriggerSWEEPING_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.source.action", - "smub.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limitv", - "smub.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limiti", - "smub.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smub.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.source.stimulus", - "smub.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitv", - "smub.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limiti", - "smub.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitp", - "smub.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smub.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smub.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smub.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "smub.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smub.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smub.source.offfunc", - "smub.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.smub.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmublimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.limit.func", - "display.smub.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smub.measure.count", - "smub.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2634B.json b/data/2634B.json deleted file mode 100644 index 96a6b04..0000000 --- a/data/2634B.json +++ /dev/null @@ -1,37285 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smub.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmubdigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smub.digits", - "display.smub.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.smub.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmubmeasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.measure.func", - "display.smub.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smub.abort()", - "webhelpfile": "15088.htm", - "signature": "smub.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smub.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smub.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smub.CALSET_NOMINAL nil|smub.CALSET_FACTORY nil|smub.CALSET_DEFAULT nil|smub.CALSET_PREVIOUS nil", - "type": "smubcalrestorecalset", - "range": "" - } - ], - "usage": [ - "smub.cal.restore()", - "smub.cal.restore(calset)" - ], - "overloads": [ - "smub.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smub.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smub.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smub.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smub.cal.adjustdate", - "smub.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smub.cal.date", - "smub.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smub.cal.due", - "smub.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smub.CAL_AUTO nil|smub.CAL_POSITIVE nil|smub.CAL_NEGATIVE nil", - "type": "smubcalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smub.cal.polarity", - "smub.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smub.CALSTATE_LOCKED nil|smub.CALSTATE_CALIBRATING nil|smub.CALSTATE_UNLOCKED nil", - "type": "smubcalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smub.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smub.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smub.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smub.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smub.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smub.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smub.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smub.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smub.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smub.CONTACT_FAST nil|smub.CONTACT_MEDIUM nil|smub.CONTACT_SLOW nil", - "type": "smubcontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smub.contact.speed", - "smub.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smub.contact.threshold", - "smub.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smub.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smub.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smub.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smub.measure.analogfilter", - "smub.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangev", - "smub.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangei", - "smub.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smub.AUTOZERO_OFF nil|smub.AUTOZERO_ONCE nil|smub.AUTOZERO_AUTO nil", - "type": "smubmeasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smub.measure.autozero", - "smub.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubmeasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smub.measure.delay", - "smub.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smub.measure.delayfactor", - "smub.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smub.measure.filter.count", - "smub.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smub.FILTER_OFF nil|smub.FILTER_ON nil", - "type": "smubmeasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smub.measure.filter.enable", - "smub.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smub.FILTER_MOVING_AVG nil|smub.FILTER_REPEAT_AVG nil|smub.FILTER_MEDIAN nil", - "type": "smubmeasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smub.measure.filter.type", - "smub.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smub.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smub.measure.highcrangedelayfactor", - "smub.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smub.measure.interval", - "smub.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangev", - "smub.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangei", - "smub.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smub.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smub.measure.nplc", - "smub.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangev", - "smub.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangei", - "smub.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.v()", - "reading = smub.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.i()", - "reading = smub.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.r()", - "reading = smub.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.p()", - "reading = smub.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)", - "iReading, vReading = smub.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablev", - "smub.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablei", - "smub.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enabler", - "smub.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablep", - "smub.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelv", - "smub.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.leveli", - "smub.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelr", - "smub.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelp", - "smub.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smub.reset()", - "webhelpfile": "15136.htm", - "signature": "smub.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smub.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smub.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smub.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smub.SENSE_LOCAL nil|smub.SENSE_REMOTE nil|smub.SENSE_CALA nil", - "type": "smubsensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smub.sense", - "smub.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangev", - "smub.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangei", - "smub.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smub.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smub.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubsourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smub.source.delay", - "smub.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smub.source.func", - "smub.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smub.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smub.source.highc", - "smub.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.levelv", - "smub.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.leveli", - "smub.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangev", - "smub.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangei", - "smub.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimitv", - "smub.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimiti", - "smub.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smub.OUTPUT_NORMAL nil|smub.OUTPUT_ZERO nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smub.source.offmode", - "smub.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smub.OUTPUT_OFF nil|smub.OUTPUT_ON nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smub.source.output", - "smub.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smub.OE_NONE nil|smub.OE_OUTPUT_OFF nil", - "type": "smubsourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smub.source.outputenableaction", - "smub.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangev", - "smub.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangei", - "smub.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smub.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smub.SETTLE_SMOOTH nil|smub.SETTLE_FAST_RANGE nil|smub.SETTLE_FAST_POLARITY nil|smub.SETTLE_DIRECT_IRANGE nil|smub.SETTLE_SMOOTH_100NA nil|smub.SETTLE_FAST_ALL nil|smub.SETTLE_FAST_ nil", - "type": "smubsourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smub.source.settling", - "smub.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smub.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smub.source.sink", - "smub.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smub.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smub.trigger.arm.count", - "smub.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smub.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.arm.stimulus", - "smub.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smubtriggerARMED_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smub.trigger.autoclear", - "smub.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smub.trigger.count", - "smub.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smub.SOURCE_IDLE1 nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smub.trigger.endpulse.action", - "smub.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smub.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.endpulse.stimulus", - "smub.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smub.SOURCE_IDLE nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.endsweep.action", - "smub.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smubtriggerIDLE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smub.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil|smub.ASYNC nil", - "type": "smubtriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.measure.action", - "smub.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smub.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.measure.stimulus", - "smub.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerMEASURE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerPULSE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSOURCE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSWEEP_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smubtriggerSWEEPING_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.source.action", - "smub.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limitv", - "smub.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limiti", - "smub.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smub.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.source.stimulus", - "smub.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitv", - "smub.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limiti", - "smub.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitp", - "smub.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smub.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smub.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smub.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "smub.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smub.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smub.source.offfunc", - "smub.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.smub.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmublimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.limit.func", - "display.smub.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smub.measure.count", - "smub.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2635B.json b/data/2635B.json deleted file mode 100644 index f572e99..0000000 --- a/data/2635B.json +++ /dev/null @@ -1,29402 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/2636B.json b/data/2636B.json deleted file mode 100644 index 96a6b04..0000000 --- a/data/2636B.json +++ /dev/null @@ -1,37285 +0,0 @@ -{ - "commands": [ - { - "name": "SweepILinMeasureV()", - "webhelpfile": "12177.htm", - "signature": "SweepILinMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear current sweep with voltage measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265 2)", - "enum": "", - "type": "number", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "SweepILinMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepILinMeasureV(smua, -1e-3, 1e-3, 0, 100);", - "description": "This function performs a 100-point linear current sweep starting at \u22121 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0\u00a0s, voltage is measured as quickly as possible after each current step.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLinMeasureI()", - "webhelpfile": "12181.htm", - "signature": "SweepVLinMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a linear voltage sweep with current measured at every step (point):The linear step size is automatically calculated as follows:", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLinMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "SweepVLinMeasureI(smua, -1, 1, 1e-3, 1000);", - "description": "This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepILogMeasureV()", - "webhelpfile": "12184.htm", - "signature": "SweepILogMeasureV(smuX, starti, stopi, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step\u00a0(point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic current sweep with voltage measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "starti", - "description": "Sweep start current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopi", - "description": "Sweep stop current in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepILogMeasureV(smuX, starti, stopi, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepIListMeasureV()", - "webhelpfile": "12190.htm", - "signature": "SweepIListMeasureV(smuX, ilist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a current list sweep with voltage measured at every step (point).", - "details": "Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a current list sweep with voltage measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "ilist", - "description": "Arbitrary list of current source values; ilist = {value1, value2, ...valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepIListMeasureV(smuX, ilist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "testilist = {-100e-9, 100e-9, -1e-6, 1e-6, -1e-3, 1e-3};\u00a0;SweepIListMeasureV(smua, testilist, 500e-3, 6);", - "description": "This function performs a six\u2011point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "SweepVLogMeasureI()", - "webhelpfile": "12192.htm", - "signature": "SweepVLogMeasureI(smuX, startv, stopv, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a logarithmic voltage sweep with current measured at every step (point):The source level at each step (SourceStepLevel) is automatically calculated as follows:For example, for a five-point sweep (points = 5), a measurement is made at MeasurePoint 1, 2, 3, 4, and 5.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "startv", - "description": "Sweep start voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stopv", - "description": "Sweep stop voltage in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVLogMeasureI(smuX, startv, stopv, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "MeasurePoint;", - "description": "LogStepSize\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "PulseIMeasureV()", - "webhelpfile": "12918.htm", - "signature": "PulseIMeasureV(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse I, measure V cycles.", - "details": "Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.If any parameters are omitted or nil, the operator is prompted to enter them using the front panel.To perform the specified number of pulse I, measure V cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseIMeasureV(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "PulseIMeasureV(smua, 0.001, 1.0,; 20e-3, 40e-3, 10);", - "description": "SMU A outputs 1\u00a0mA and dwells for 40\u00a0ms, outputs 1\u00a0A and dwells for 20\u00a0ms. The voltage measurements occur during each 20\u00a0ms dwell period. After the measurement, the output returns to 1\u00a0mA and dwells for 40\u00a0ms. This pulse\u2011measure process repeats nine more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "PulseVMeasureI()", - "webhelpfile": "12923.htm", - "signature": "PulseVMeasureI(smu, bias, level, ton, toff, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function performs a specified number of pulse V, measure I cycles.", - "details": "If any parameters are omitted or nil, the operator is prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.To perform the specified number of pulse V, measure I cycles, this function:", - "param_info": [ - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "PulseVMeasureI(smu, bias, level, ton, toff, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.001;PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20);", - "description": "SMU A outputs \u22121\u00a0V and dwells for 2\u00a0ms, outputs 1\u00a0V and dwells for 1\u00a0ms. The current measurements occur during each 1\u00a0ms dwell period. After the measurement, the output returns to \u22121\u00a0V and dwells for 2\u00a0ms. This pulse-measure process repeats 19 more times.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseIMeasureV()", - "webhelpfile": "12926.htm", - "signature": "ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It simply checks to see if all the pulse dimensions can be achieved, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureV(smua, 0, 5, 10, 0.001, 0.080, 1, smua.nvbuffer1, 1);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 5\u00a0A and returns to 0\u00a0A after 1\u00a0ms. The pulse remains at 0\u00a0A for 80 ms and the voltage limit is 10\u00a0V during the pulse. The pulse train consists of only 1 pulse, and this pulse is assigned a tag index of 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTest()", - "webhelpfile": "12929.htm", - "signature": "InitiatePulseTest(tag)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned to tag.", - "details": "This function only initiates configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors are encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string that indicates successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier of the pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTest(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;if f1 == true then; f2, msg2 = InitiatePulseTest(1); print(\"Initiate message:\", msg2);else; print(\"Config errors:\", msg1);end;", - "description": "Configure channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms and the bias level for 200\u00a0ms, with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "InitiatePulseTestDual()", - "webhelpfile": "12934.htm", - "signature": "InitiatePulseTestDual(tag1, tag2)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function initiates the pulse configuration assigned tag1 and tag2.", - "details": "The pulse trains associated with the indicated tags are generated simultaneously. This is useful when testing devices such as voltage regulators, where the input signal and output load must be applied to the instrument at the same time. When using this function, each tag1 pulse encapsulates each tag2 pulse in time. Specifically, the tag1 pulse transitions from its bias level to its pulse level before the tag2 pulse. Both the tag1 and tag2 pulses return to their respective bias levels at approximately the same time. Measurements for both pulse trains occur at the same time (see the waveform in the figure below).To provide this encapsulation, the following rules are enforced:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "tag1", - "description": "Numeric identifier of the first pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tag2", - "description": "Numeric identifier of the second pulse configuration to be initiated", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = InitiatePulseTestDual(tag1, tag2)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;smub.reset();smub.source.func = smub.OUTPUT_DCAMPS;smub.source.rangei = 1;smub.source.rangev = 5;smub.source.leveli = 0;smub.measure.rangei = 1;smub.measure.rangev = 5;smub.measure.nplc = 0.01;smub.measure.autozero = smub.AUTOZERO_ONCE;smub.nvbuffer1.clear();smub.nvbuffer1.appendmode = 1;smub.source.output = smub.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5, 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);f2, msg2 = ConfigPulseIMeasureV(smub, 0,-1, 5, 0.001, 0.2, 10, smub.nvbuffer1, 2);if (f1 == true) and (f2 == true) then; f3, msg3 = InitiatePulseTestDual(1, 2); print(\"Initiate message:\", msg3);else; print(\"Config errors:\", msg1, msg2);end;", - "description": "Set up channels A and B for pulse operation, configure pulse trains for each channel, and then initiate the pulse trains if no errors are encountered.\n--- --Channel A pulses voltage from a bias level of 0\u00a0V to pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting.\n--- --A total of 10 pulses is generated on channel A and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Channel B pulses current from a bias level of 0\u00a0A to pulse level of 1\u00a0A. The pulse level is present for 1 ms, and the bias level for 200\u00a0ms with a 5\u00a0V limit setting.\n--- --A total of 10 pulses is generated on channel B, and the measurement data is stored in smub.nvbuffer1. This pulse train is assigned to tag = 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLin()", - "webhelpfile": "12937.htm", - "signature": "ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is step amperes larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true if the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff,points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 1, 1e-3, 0.1, 20, smua.nvbuffer2, 3);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 10\u00a0mA, ends at 50\u00a0mA, and returns to a 0\u00a0mA bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 100\u00a0ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 20 pulsed steps and the pulse train is assigned a tag index of 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLin()", - "webhelpfile": "12940.htm", - "signature": "ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is step volts larger than the previous pulse, where:step = (stop - start) / (points - 1)This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag. ", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is\u00a010\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLin(smua, 0, 1, 10, 1, 10e-3, 20e-3, 16, smua.nvbuffer1, 4);", - "description": "Set up a pulsed sweep that uses channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 16 pulsed steps, and the pulse train is assigned a tag index of 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureISweepLog()", - "webhelpfile": "12946.htm", - "signature": "ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start volts; the magnitude of the last pulse is stop volts. The magnitude of each pulse in between is LogStepn volts larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) functions are used to initiate a pulse train assigned to a valid tag.", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureISweepLog(smua, 0, 1, 10, 1, 10e-3, 20e-3, 10, smua.nvbuffer1, 6);", - "description": "Set up a pulsed logarithmic sweep that uses SMU channel A. The pulsed sweep starts at 1\u00a0V, ends at 10\u00a0V, and returns to a 0\u00a0V bias level between pulses. Each pulsed step is on for 10\u00a0ms, and then at the bias level for 20\u00a0ms. \n--- --The current limit is 1 A during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 6.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "KIPulse factory script" - ] - }, - { - "name": "QueryPulseConfig()", - "webhelpfile": "12949.htm", - "signature": "QueryPulseConfig(tag)", - "command_return": "tbl", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.", - "details": "Once a pulse train is configured and assigned to a tag, you can use the QueryPulseConfig() command to inspect the settings of this preconfigured pulse train.This function returns a table that contains the settings associated with the tag input parameter.", - "param_info": [ - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "tbl", - "description": "Returned table", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "tbl = QueryPulseConfig(tag)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();\u00a0;smua.source.rangev = 5;smua.source.rangei = 1;smua.source.levelv = 0;\u00a0;smua.measure.rangev = 5;smua.measure.rangei = 1;smua.measure.nplc = 0.01;smua.measure.autozero = smua.AUTOZERO_ONCE;\u00a0;smua.nvbuffer1.clear();smua.nvbuffer1.appendmode = 1;\u00a0;smua.source.output = smua.OUTPUT_ON;\u00a0;f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,; 1, 0.002, 0.2, 10, smua.nvbuffer1, 1);\u00a0;print(QueryPulseConfig(1).tostring());", - "description": "Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A pulses voltage from a bias level of 0\u00a0V to a pulse level of 5\u00a0V. The pulse level is present for 2\u00a0ms, and the bias level for 200\u00a0ms with a 1\u00a0A limit setting. A total of 10 pulses is generated, and the measurement data is stored in smua.nvbuffer1. This pulse train is assigned to tag = 1.\n--- --Output:\n--- -->> tag = 1\n--- -->> smu = smua\n--- -->> func = volts\n--- -->> type = pulse\n--- -->> bias = 0\n--- -->> level = 5\n--- -->> limit = 1\n--- -->> time on = 0.002\n--- -->> time off = 0.2\n--- -->> points = 10\n--- -->> measure = yes\n--- -->> sync_in = 0\n--- -->> sync_out = 0\n--- -->> sync_in_timeout = 0\n--- -->> sync_out_abort = 0\n--- -->> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "ConfigPulseIMeasureV()", - "ConfigPulseIMeasureVSweepLin()", - "ConfigPulseIMeasureVSweepLog()", - "ConfigPulseVMeasureI()", - "ConfigPulseVMeasureISweepLin()", - "ConfigPulseVMeasureISweepLog()", - "KIPulse factory script" - ] - }, - { - "name": "i_leakage_measure()", - "webhelpfile": "12951.htm", - "signature": "i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)", - "command_return": "imeas", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function performs a current leakage measurement after stepping the output\u00a0voltage.", - "details": "This function causes the SMU to:When measuring leakage current:", - "param_info": [ - { - "name": "imeas", - "description": "The measured current", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Instrument channel (for example, smua refers to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel\u00a0A)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay to wait after lowering the current limit before making the measurement", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "imeas = i_leakage_measure(smuX, levelv, limiti, sourcedelay, measurei, measuredelay)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);imeas = i_leakage_measure(smua, 0, 1, 300e-3, 10e-6, 0.1);", - "description": "Enable high-capacitance mode. Charge the capacitor at 5\u00a0V for 1 second set by delay(1).\n--- --\u00a0\n--- --The parameters passed on to the i_leakage_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --The levels and delays depend on the value and type of capacitor used.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "i_leakage_threshold()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "i_leakage_threshold()", - "webhelpfile": "12953.htm", - "signature": "i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)", - "command_return": "f", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIHighC factory script function measures the current and compares it to a threshold. This continues until either the measured current drops below the threshold or the timeout expires.", - "details": "This function causes the SMU to:When testing the leakage current threshold:", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the current is below the threshold, false if threshold is not reached before timeout expires", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "levelv", - "description": "Voltage level to step to when this function is called", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limiti", - "description": "Current limit setting for the voltage step", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sourcedelay", - "description": "Delay to wait before lowering the current limit for measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measurei", - "description": "Current limit (and measure range); the current limit is lower at this level and because high-capacitance mode is active, the measure range follows", - "enum": "", - "type": "number", - "range": "(and measure range)" - }, - { - "name": "measuredelay", - "description": "Delay before the first measurement after measure range is changed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "threshold", - "description": "The specified current that establishes the test limit", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "f = i_leakage_threshold(smuX, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;smua.source.levelv = 5;smua.source.output = smua.OUTPUT_ON;delay(1);pass = i_leakage_threshold(smua, 0, 1, 300e-3, 10e-6, 100e-3, 1e-6, 1);", - "description": "Enable high-capacitance mode.\n--- --Charge the capacitor. \n--- --\u00a0\n--- --The parameters passed on to the i_threshold_measure() function in this example are:\n--- --smu = smua\n--- --levelv = 0\u00a0V\n--- --limiti = 1\u00a0A\n--- --sourcedelay = 300\u00a0ms\n--- --measurei = 10 \u00b5A range\n--- --measuredelay = 100 ms\n--- --threshold = 1\u00a0\u00b5A\n--- --timeout = 1 s\n--- --The levels and delays depend on the value and type of capacitor used.\n--- --Sets pass = true if the current is measured below 1\u00a0\u00b5A in less than 1 second.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "i_leakage_measure()", - "High-capacitance mode", - "KIHighC factory script" - ] - }, - { - "name": "gm_vsweep()", - "webhelpfile": "12955.htm", - "signature": "gm_vsweep(smu, start_v, stop_v, points)", - "command_return": "gm_array, ibuf, vbuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.", - "details": "Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_v", - "description": "Starting voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "stop_v", - "description": "Ending voltage level of the sweep ", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_v and stop_v (must be \u2265 2)", - "enum": "", - "type": "any", - "range": "(must be \u2265 2)" - } - ], - "usage": [ - "gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_vsweep(smua, 0, 5, 20);\u00a0;gm_array, ibuf = gm_vsweep(smua, 0, 5, 20);\u00a0;\u00a0;gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20);", - "description": "SMU A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured currents.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured currents and voltages.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_isweep()", - "KIParlib factory script" - ] - }, - { - "name": "gm_isweep()", - "webhelpfile": "12957.htm", - "signature": "gm_isweep(smu, start_i, stop_i, points)", - "command_return": "gm_array, vbuf, ibuf", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each\u00a0point.", - "details": "Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured\u00a0currents.", - "param_info": [ - { - "name": "gm_array", - "description": "A Lua table containing the calculated Gm values at each point", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "vbuf", - "description": "A reading buffer containing the measured voltage at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "ibuf", - "description": "A reading buffer containing the measured current at each point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "start_i", - "description": "Starting current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop_i", - "description": "Ending current level of the sweep ", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of measurements between start_i and stop_i (must be \u22652)", - "enum": "", - "type": "number", - "range": "(must be \u22652)" - } - ], - "usage": [ - "gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)" - ], - "overloads": [], - "examples": [ - { - "example": "gm_array = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20);\u00a0;\u00a0;gm_array, vbuf, ibuf = gm_isweep(smua, 0,; 0.01, 20);", - "description": "Source\u2011measure unit (SMU) A returns Gm values only.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffer with measured voltages.\n--- --\u00a0\n--- --SMU A returns Gm and reading buffers with measured voltages and currents.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gm_vsweep()", - "KIParlib factory script" - ] - }, - { - "name": "savebuffer()", - "webhelpfile": "12959.htm", - "signature": "savebuffer(buffer, formatType, fileName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISavebuffer factory script function saves a specified reading buffer as either a CSV file or an XML file.", - "details": "Use this function to save the specified buffer to a USB flash drive.This function only saves to a USB flash drive. You are not required to qualify the path to the USB flash drive, but you can add /usb1/ before the fileName (see Example 2).", - "param_info": [ - { - "name": "buffer", - "description": "The reading buffer to save", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "formatType", - "description": "A string indicating which file type to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileName", - "description": "The file name of the saved buffer", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "savebuffer(buffer, formatType, fileName)" - ], - "overloads": [], - "examples": [ - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 as a CSV file named mybuffer.csv.\n" - }, - { - "example": "savebuffer(smua.nvbuffer1, \"csv\", \"/usb1/mybuffer.csv\");", - "description": "Save smua dedicated reading buffer 1 to an installed USB flash drive as a CSV file named mybuffer.csv.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISavebuffer factory script", - "smuX.savebuffer()" - ] - }, - { - "name": "reset()", - "webhelpfile": "13933.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings.", - "details": "The reset() command in its simplest form resets the entire TSP\u2011enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. Use the localnode.reset() command for the local instrument. Use the node[X].reset() command to reset an instrument on a subordinate node.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error.", - "param_info": [ - { - "name": "system", - "description": "What to reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.reset()" - ] - }, - { - "name": "settime()", - "webhelpfile": "13943.htm", - "signature": "settime(time)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the real-time clock (sets present time of the system).", - "details": "This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "time", - "description": "The time in seconds since January 1, 1970 UTC", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "settime(time)" - ], - "overloads": [], - "examples": [ - { - "example": "systemTime = os.time({year = 2020,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2020 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settimezone()" - ] - }, - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0\u00a0s to 100 ks)", - "enum": "", - "type": "number", - "range": "(0\u00a0s to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double\u2011beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user\u2011defined string catalog.", - "details": "The catalog provides access for user\u2011defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user\u2011defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key\u2011value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user\u2011defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user\u2011defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user\u2011defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP\u2011enabled. The 2600B does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP\u2011enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP\u2011enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the 2600B sends an abort command to the remote device on connection. The 2600B also enables TSP prompts on the remote device and error management. The 2600B places remote errors from the TSP\u2011enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device. If you do this, subsequent tspnet.tsp.* commands using the connection may fail.You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string; accepts IP address or host name when trying to connect", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP\u2011enabled.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts", - "localnode.showerrors", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP\u2011Net session.\n--- --Close the session.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The 2600B decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the 2600B suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The 2600B places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear\u00a0as:\n--- --Keithley Instruments,Model 2600B, 1398687, 1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the 2600B pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the 2600B reads from a TSP-enabled remote instrument, the 2600B removes Test Script Processor (TSP\u00ae) prompts and places any errors it receives from the remote instrument into its own error queue. The 2600B prefaces errors from the remote device with \"Remote Error,\" followed by the error number and error description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");repeat bytes = tspnet.readavailable(ID) until bytes > 0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that create data.\n--- --Wait for data to be available.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "14082.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP\u2011enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "An enumerated value indicating the termination type", - "enum": "tspnet.TERM_LF4 nil|tspnet.TERM_CR2 nil|tspnet.TERM_CRLF3 nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "", - "type": "tspnetterminationtermSquence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP\u2011enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP\u2011enabled remote instrument results in a connection. However, the instrument does not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP\u2011enabled\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The 2600B sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma\u2011delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "t = tspnet.tsp.rbtablecopy(testConnection, \"testRemotebuffername.readings\", 1, 3);print(t[1], t[2], t[3]);", - "description": "Copy the specified readings table for buffer items 1 through 3, then display the first three readings.\n--- --Example output:\n--- --4.56534e-01\n--- --4.52675e-01\n--- --4.57535e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "beeper.enable", - "webhelpfile": "14435.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (beeper.ON)\n", - "tsp_link": "Yes\n", - "description": "This command allows you to turn the beeper on or off.", - "details": "This command enables or disables the beeper. When enabled, a beep signals that a front\u2011panel key has been pressed. Disabling the beeper also disables front\u2011panel key clicks.", - "param_info": [ - { - "name": "state", - "description": "Disable the beeper", - "enum": "beeper.OFF 0|beeper.ON 1", - "type": "beeperenablestate", - "range": "" - } - ], - "usage": [ - "state = beeper.enable", - "beeper.enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.beep()" - ] - }, - { - "name": "bit.bitand()", - "webhelpfile": "14632.htm", - "signature": "bit.bitand(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical AND operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical AND operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitand(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitand(10, 9);print(testResult);", - "description": "Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitor()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitor()", - "webhelpfile": "14634.htm", - "signature": "bit.bitor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical OR operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an\u00a0integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical OR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitor(10, 9);print(testResult);", - "description": "Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitxor()" - ] - }, - { - "name": "bit.bitxor()", - "webhelpfile": "14635.htm", - "signature": "bit.bitxor(value1, value2)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.", - "details": "Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value1", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Operand for the logical XOR operation", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.bitxor(value1, value2)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.bitxor(10, 9);print(testResult);", - "description": "Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).\n--- --Output:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.bitand()", - "bit.bitor()" - ] - }, - { - "name": "bit.clear()", - "webhelpfile": "14636.htm", - "signature": "bit.clear(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears a bit at a specified index position.", - "details": "Any fractional part of value is truncated to make it an integer. The returned result is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to clear (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.clear(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.clear(15, 2);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary\u00a01101).\n--- --Output:\n--- --1.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.get()", - "webhelpfile": "14637.htm", - "signature": "bit.get(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the weighted value of a bit at a specified index position.", - "details": "This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero\u00a0(0).The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for the number is set to zero (0), the result is zero (0).", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.get(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.get(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value\u00a0is 8.\n--- --Output:\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.set()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.getfield()", - "webhelpfile": "14638.htm", - "signature": "bit.getfield(value, index, width)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns a field of bits from the value starting at the specified index position.", - "details": "A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at\u00a0index.The index position is the least significant bit of the retrieved field. The number of bits to return is specified by\u00a0width.The least significant bit of value is at index position 1; the most significant bit is at index\u00a0position\u00a032.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to get (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.getfield(value, index, width)" - ], - "overloads": [], - "examples": [ - { - "example": "myResult = bit.getfield(13, 2, 3);print(myResult);", - "description": "The binary equivalent of decimal 13 is 1101. \n--- --The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).\n--- --Output:\n--- --6.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.setfield()" - ] - }, - { - "name": "bit.set()", - "webhelpfile": "14639.htm", - "signature": "bit.set(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets a bit at the specified index position.", - "details": "This function returns result, which is value with the indexed bit set. The index must be between\u00a01\u00a0and 32.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Any fractional part of value is truncated to make it an integer.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.set(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.set(8, 3);\u00a0;print(testResult);", - "description": "The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary\u00a01100).\n--- --Output:\n--- --1.20000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.getfield()", - "bit.setfield()", - "bit.test()", - "bit.toggle()" - ] - }, - { - "name": "bit.setfield()", - "webhelpfile": "14640.htm", - "signature": "bit.setfield(value, index, width, fieldValue)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function overwrites a bit field at a specified index position.", - "details": "This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to\u00a0fieldValue.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5\u00a0bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position in value to set (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "width", - "description": "The number of bits to include in the field (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - }, - { - "name": "fieldValue", - "description": "Value to write to the field", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = bit.setfield(value, index, width, fieldValue)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.setfield(15, 2, 3, 5);print(testResult);", - "description": "The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).\n--- --Output:\n--- --1.10000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.get()", - "bit.set()", - "bit.getfield()" - ] - }, - { - "name": "bit.test()", - "webhelpfile": "14641.htm", - "signature": "bit.test(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the Boolean value (true or false) of a bit at the specified index position.", - "details": "This function returns result, which is the result of the tested bit. The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is\u00a0true.If index is bigger than the number of bits in value, the result is false.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to test (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.test(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.test(10, 4);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of\u00a0true.\n--- --Output:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.toggle()" - ] - }, - { - "name": "bit.toggle()", - "webhelpfile": "14642.htm", - "signature": "bit.toggle(value, index)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function toggles the value of a bit at a specified index position.", - "details": "This function returns result, which is the result of toggling the bit index in value.Any fractional part of value is truncated to make it an integer. The returned value is also an integer.The least significant bit of value is at index position 1; the most significant bit is at index position\u00a032.The indexed bit for value is toggled from 0 to 1, or 1 to 0.", - "param_info": [ - { - "name": "result", - "description": "Result of the bit manipulation", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value", - "description": "Specified number", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "index", - "description": "One\u2011based bit position within value to toggle (1 to 32)", - "enum": "", - "type": "number", - "range": "(1 to 32)" - } - ], - "usage": [ - "result = bit.toggle(value, index)" - ], - "overloads": [], - "examples": [ - { - "example": "testResult = bit.toggle(10, 3);print(testResult);", - "description": "The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary\u00a01110).\n--- --Output:\n--- --1.40000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Bit manipulation and logic operations", - "bit.clear()", - "bit.get()", - "bit.set()", - "bit.test()" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output:There are 128 items in the dataqueueThere are 0 items in the data queue", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "digio.readbit()", - "webhelpfile": "14668.htm", - "signature": "digio.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads one digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O line number to be read (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "data = digio.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "print(digio.readbit(4));", - "description": "Assume line 4 is set high, and it is then read.\n--- --Output:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readport()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "14669.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.\n--- --Output:\n--- --1.70000e+02\n--- --This is binary 10101010.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.writebit()", - "digio.writeport()", - "Digital I/O port" - ] - }, - { - "name": "digio.trigger[N].assert()", - "webhelpfile": "14670.htm", - "signature": "digio.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].assert();", - "description": "Asserts a trigger on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].clear()", - "webhelpfile": "14671.htm", - "signature": "digio.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital I/O line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The event detector of a trigger enters the detected state when an event is detected. It is cleared when digio.trigger[N].wait() or digio.trigger[N].clear() is called.digio.trigger[N].clear() clears the event detector of the specified trigger line, discards the history of the trigger line, and clears the digio.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].overrun", - "digio.trigger[N].wait()" - ] - }, - { - "name": "digio.trigger[N].EVENT_ID", - "webhelpfile": "14672.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the digital I/O line N. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To have another trigger object respond to trigger events generated by the trigger line, set the stimulus attribute of the other object to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "eventID = digio.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID;", - "description": "Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "digio.trigger[N].mode", - "webhelpfile": "14674.htm", - "signature": "", - "command_return": "triggerMode", - "type": "Attribute (RW)", - "default_value": "0 (digio.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set triggerMode to one of the following values:When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user\u2011specified output state of the line is ignored.Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on older firmware.To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.", - "param_info": [ - { - "name": "triggerMode", - "description": "The trigger mode; see Details for values", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerMode = digio.trigger[N].mode", - "digio.trigger[N].mode = triggerMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].mode = 2;", - "description": "Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()", - "digio.writebit()", - "digio.writeport()", - "Sweep operation" - ] - }, - { - "name": "digio.trigger[N].overrun", - "webhelpfile": "14675.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "overrun = digio.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = digio.trigger[1].overrun;print(overrun);", - "description": "If there is no trigger overrun, the following text is output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].release()", - "webhelpfile": "14677.htm", - "signature": "digio.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth" - ] - }, - { - "name": "digio.trigger[N].wait()", - "webhelpfile": "14679.htm", - "signature": "digio.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function pauses trigger operation up to the seconds set by timeout for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "The value is true if a trigger is detected, or false if no triggers are detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = digio.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = digio.trigger[4].wait(3);print(triggered);", - "description": "Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].clear()" - ] - }, - { - "name": "digio.writebit()", - "webhelpfile": "14680.htm", - "signature": "digio.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If the output line is write\u2011protected using the digio.writeprotect attribute, the command is ignored.The reset() function does not affect the present state of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "digio.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writebit(4, 0);", - "description": "Sets digital I/O line 4 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.trigger[N].mode", - "digio.writeport()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "14681.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).Write\u2011protected lines are not changed.The reset() function does not affect the present states of the digital I/O lines.Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 16383)", - "enum": "", - "type": "number", - "range": "(0 to 16383)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(255);", - "description": "Sets digital I/O Lines 1 through 8 high (binary 00000011111111).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.readbit()", - "digio.readport()", - "digio.writebit()", - "digio.writeprotect" - ] - }, - { - "name": "digio.writeprotect", - "webhelpfile": "14682.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Bits that are set to one cause the corresponding line to be write\u2011protected.The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write\u2011protects lines 1, 2, and 3.", - "param_info": [ - { - "name": "mask", - "description": "Sets the value that specifies the bit pattern for write\u2011protect", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = digio.writeprotect", - "digio.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeprotect = 15;", - "description": "Write\u2011protects lines 1, 2, 3, and 4.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "14699.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all lines of the front\u2011panel display.", - "details": "This function switches to the user screen and then clears the front\u2011panel display.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.", - "param_info": [], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.getcursor()", - "webhelpfile": "14700.htm", - "signature": "display.getcursor()", - "command_return": "row, column, style", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the present position of the cursor on the front\u2011panel display.", - "details": "This function switches the front\u2011panel display to the user screen (the text set by display.settext()), and then returns values to indicate the row that contains the cursor and the column position and cursor\u00a0style.Columns are numbered from left to right on the display.", - "param_info": [ - { - "name": "row", - "description": "The row where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "column", - "description": "The column where the cursor is", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Visibility of the cursor", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "row, column, style = display.getcursor()" - ], - "overloads": [], - "examples": [ - { - "example": "testRow, testColumn = display.getcursor();print(testRow, testColumn);", - "description": "This example reads the cursor position into local variables and prints them.\n--- --Example output:\n--- --1.00000e+00 1.00000e+00\n" - }, - { - "example": "print(display.getcursor());", - "description": "This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:\n--- --1.00000e+00 3.00000e+00 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.gettext()", - "display.screen", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.gettext()", - "webhelpfile": "14702.htm", - "signature": "display.gettext(embellished, row, columnStart, columnEnd)", - "command_return": "text", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the text displayed on the front panel.", - "details": "Using the command without any parameters returns both lines of the front\u2011panel\u00a0display.The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().The display is not switched to the user screen (the screen set using display.settext()). Text is read from the active screen.", - "param_info": [ - { - "name": "text", - "description": "The returned value, which contains the text that is presently displayed", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "embellished", - "description": "Indicates type of returned text", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "row", - "description": "Selects the row from which to read the text", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnStart", - "description": "Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "columnEnd", - "description": "Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)", - "text = display.gettext(embellished, row, columnStart, columnEnd)" - ], - "overloads": [ - "text = display.gettext()", - "text = display.gettext(embellished)", - "text = display.gettext(embellished, row)", - "text = display.gettext(embellished, row, columnStart)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 1);display.settext(\"ABCDEFGHIJ$DKLMNOPQRST\");display.setcursor(2, 1);display.settext(\"abcdefghijklm$Bnopqrstuvwxyz$F123456\");print(display.gettext());print(display.gettext(true));print(display.gettext(false, 2));print(display.gettext(true, 2, 9));print(display.gettext(false, 2, 9, 10));", - "description": "This example shows how to retrieve the display text in multiple ways. The output is:\n--- --\u00a0\n--- --ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456\n--- --$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456\n--- --abcdefghijklmnopqrstuvwxyz123456\n--- --$Rijklm$Bnopqrstuvwxyz$F123456\n--- --ij\n" - }, - { - "example": "display.clear();display.settext(\"User Screen\");text = display.gettext();print(text);", - "description": "This outputs all text in both lines of the display:\n--- --User Screen $N\n--- --This indicates that the message \u201cUser Screen\u201d is on the top line. The bottom line is blank.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.inputvalue()", - "webhelpfile": "14703.htm", - "signature": "display.inputvalue(format, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays a formatted input field on the front\u2011panel display that the operator can edit.", - "details": "The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.The default parameter is the value shown when the value is first displayed.You can use the minimum and maximum parameters to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.The input value is limited to \u00b11e37.Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.After this command is sent, script execution pauses until you enter a value and press the ENTER key.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity is also toggled when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "default", - "description": "The default value for the input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)", - "display.inputvalue(format, default, minimum, maximum)" - ], - "overloads": [ - "display.inputvalue(format)", - "display.inputvalue(format, default)", - "display.inputvalue(format, default, minimum)" - ], - "examples": [ - { - "example": "display.clear();display.settext(\"Enter value between$N -0.10 and 2.00: \");value = display.inputvalue(\"+0.00\", 0.5, -0.1, 2.0);print(\"Value entered = \", value);", - "description": "Displays an editable field (+0.50) for operator input. The valid input range is \u22120.10 to +2.00, with a default of\u00a00.50.\n--- --Output:\n--- --Value entered = 1.35000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.prompt()", - "display.setcursor()", - "display.settext()" - ] - }, - { - "name": "display.loadmenu.catalog()", - "webhelpfile": "14705.htm", - "signature": "for displayName, code in display.loadmenu.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user menu items accessed using the LOAD key on the front panel.", - "details": "Each time through the loop, displayName and code take on the values in the USER menu.The instrument goes through the list in random order.", - "param_info": [ - { - "name": "displayName", - "description": "The name displayed in the menu", - "enum": "", - "type": "String", - "range": "" - }, - { - "name": "code", - "description": "The code associated with the displayName", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "The body of the code to process the entries in the loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for displayName in display.loadmenu.catalog() do body end", - "for displayName, code in display.loadmenu.catalog() do body end" - ], - "overloads": [ - "for displayName in display.loadmenu.catalog() do body end" - ], - "examples": [ - { - "example": "for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n--- --Test9 Test9()\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.delete()" - ] - }, - { - "name": "display.loadmenu.delete()", - "webhelpfile": "14706.htm", - "signature": "display.loadmenu.delete(displayName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes an entry from the USER menu, which can be accessed using the LOAD key on the front\u00a0panel.", - "details": "If you delete an entry from the USER menu, you can no longer run it by pressing the LOAD key.", - "param_info": [ - { - "name": "displayName", - "description": "The name to be deleted from the USER menu", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "display.loadmenu.delete(displayName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.loadmenu.delete(\"Test9\");for displayName, code in display.loadmenu.catalog() do; print(displayName, code);end;", - "description": "Deletes the entry named Test9.\n--- --Output:\n--- --Test DUT1() beeper.beep(2, 500)\n--- --Part1 testpart([[Part1]], 5.0)\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.add()", - "display.loadmenu.catalog()" - ] - }, - { - "name": "display.locallockout", - "webhelpfile": "14707.htm", - "signature": "", - "command_return": "lockout", - "type": "Attribute (RW)", - "default_value": "0 (display.UNLOCK)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.", - "details": "Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script or remote operation.", - "param_info": [ - { - "name": "lockout", - "description": "0 or display.UNLOCK", - "enum": "display.UNLOCK nil|display.LOCK nil", - "type": "displaylocallockoutlockout", - "range": "" - } - ], - "usage": [ - "lockout = display.locallockout", - "display.locallockout = lockout" - ], - "overloads": [], - "examples": [ - { - "example": "display.locallockout = display.LOCK;", - "description": "Disables the front\u2011panel EXIT (LOCAL) key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.menu()", - "webhelpfile": "14708.htm", - "signature": "display.menu(name, items)", - "command_return": "selection", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function presents a menu on the front\u2011panel display.", - "details": "The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.Pressing the EXIT (LOCAL) key does not abort the script while the menu is displayed, but it does return nil. The script can be aborted by calling the exit function when nil is returned.", - "param_info": [ - { - "name": "selection", - "description": "Name of the variable that holds the selected menu item", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "Menu name to display on the top line", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "items", - "description": "Menu items to display on the bottom line", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "selection = display.menu(name, items)" - ], - "overloads": [], - "examples": [ - { - "example": "selection = display.menu(\"Menu\", \"Test1 Test2 Test3\");print(selection);", - "description": "Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.\n--- --Output:\n--- --Test2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.numpad", - "webhelpfile": "14709.htm", - "signature": "", - "command_return": "numericKeypad", - "type": "Attribute (RW)", - "default_value": "1 (display.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls whether the front panel keys act as a numeric keypad during value entry.", - "details": "The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.", - "param_info": [ - { - "name": "numericKeypad", - "description": "Enable the numeric keypad feature (1 or display.ENABLE)Disable the numeric keypad feature (0 or display.DISABLE)", - "enum": "display.ENABLE nil|display.DISABLE nil", - "type": "displaynumpadnumericKeypad", - "range": "(1 or display.ENABLE)" - } - ], - "usage": [ - "numericKeypad = display.numpad", - "display.numpad = numericKeypad" - ], - "overloads": [], - "examples": [ - { - "example": "display.numpad = display.ENABLE;", - "description": "Turn on the numeric keypad feature.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cSetting a value\u201d in the Model 2600B User's Manual" - ] - }, - { - "name": "display.setcursor()", - "webhelpfile": "14711.htm", - "signature": "display.setcursor(row, column, style)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the position of the cursor.", - "details": "Sending this command selects the user screen and then moves the cursor to the given location.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.An out\u2011of-range parameter for row sets the cursor to row 2. An out\u2011of\u2011range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.An out\u2011of\u2011range parameter for style sets it to 0 (invisible).A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.", - "param_info": [ - { - "name": "row", - "description": "The row number for the cursor (1 or 2)", - "enum": "", - "type": "number", - "range": "(1 or 2)" - }, - { - "name": "column", - "description": "The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "style", - "description": "Set the cursor to invisible (0, default) or blinking (1)", - "enum": "", - "type": "number", - "range": "(0, default)" - } - ], - "usage": [ - "display.setcursor(row, column)", - "display.setcursor(row, column, style)" - ], - "overloads": [ - "display.setcursor(row, column)" - ], - "examples": [ - { - "example": "display.clear();display.setcursor(1, 8);display.settext(\"Hello\");display.setcursor(2, 14);display.settext(\"World\");", - "description": "This example displays a message on the front panel, approximately center. Note that the top line of text is larger than the bottom line of text.\n--- --The front panel of the instrument displays Hello on the top line and World on the second line.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.settext()" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "14712.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function displays text on the front\u2011panel user screen.", - "details": "This function selects the user display screen and displays the given text.After the instrument is turned on, the first time you use a display command to write to the display, the message \"User Screen\" is cleared. After the first write, you need to use display.clear() to clear the message.The display.clear(), display.setcursor(), and display.settext() functions are overlapped commands. That is, the script does not wait for one of these commands to complete. These functions do not immediately update the display. For performance considerations, they update the display as soon as processing time becomes available.The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains at the end of the line.The text remains on the display until replaced or cleared.The character codes described in the following table can also be included in the text string.", - "param_info": [], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(\"Normal $BBlinking$N\");display.settext(\"$DDim $FBackgroundBlink$R $$$$ 2 dollars\");", - "description": "This example sets the display to:\n--- --Normal Blinking\n--- --Dim BackgroundBlink $$ 2 dollars\n--- --with the named effect on each word.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.clear()", - "display.getcursor()", - "display.gettext()", - "display.screen", - "display.setcursor()" - ] - }, - { - "name": "display.smua.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmuadigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smua.digits", - "display.smua.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smub.digits", - "webhelpfile": "14713.htm", - "signature": "", - "command_return": "digits", - "type": "Attribute (RW)", - "default_value": "5 (display.DIGITS_5_5)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the front\u2011panel display resolution of the selected measurement.", - "details": "SMU A and SMU B can be set for different measurement display resolutions.", - "param_info": [ - { - "name": "digits", - "description": "Set digits to one of the following values", - "enum": "display.DIGITS_4_5 nil|display.DIGITS_5_5 nil|display.DIGITS_6_5 nil", - "type": "displaysmubdigitsdigits", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "digits = display.smub.digits", - "display.smub.digits = digits" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.digits = display.DIGITS_5_5;", - "description": "Select 5\u00bd digit resolution for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None", - "" - ] - }, - { - "name": "display.smua.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmuameasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.measure.func", - "display.smua.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.smub.measure.func", - "webhelpfile": "14714.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "1 (display.MEASURE_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the type of measurement that is being displayed.", - "details": "Selects the measurement function that is displayed on the front panel: Amps, volts, ohms, or\u00a0watts.SMU A and SMU B can be set for different measurement functions.", - "param_info": [ - { - "name": "func", - "description": "The type of measurement", - "enum": "display.MEASURE_DCAMPS nil|display.MEASURE_DCVOLTS nil|display.MEASURE_OHMS nil|display.MEASURE_WATTS nil", - "type": "displaysmubmeasurefuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.measure.func", - "display.smub.measure.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.measure.func = display.MEASURE_DCAMPS;", - "description": "Selects the current measure function for SMU A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.limit.func" - ] - }, - { - "name": "display.trigger.clear()", - "webhelpfile": "14715.htm", - "signature": "display.trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the front\u2011panel trigger event detector.", - "details": "The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger event detector and discards the previous history of TRIG key presses.This attribute also clears the display.trigger.overrun attribute.", - "param_info": [], - "usage": [ - "display.trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.overrun", - "display.trigger.wait()" - ] - }, - { - "name": "display.trigger.EVENT_ID", - "webhelpfile": "14716.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event ID of the event generated when the front\u2011panel TRIG key is pressed.", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.None", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = display.EVENT_ID" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [] - }, - { - "name": "display.trigger.wait()", - "webhelpfile": "14717.htm", - "signature": "display.trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for the TRIG key on the front panel to be pressed.", - "details": "If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.Use the display.trigger.clear() call to clear the trigger event detector.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = display.trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = display.trigger.wait(5);print(triggered);", - "description": "Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.getannunciators()", - "webhelpfile": "14719.htm", - "signature": "display.getannunciators()", - "command_return": "annunciators", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the annunciators (indicators) that are presently turned on.", - "details": "This function returns a bitmasked value showing which indicators are turned on. The 16\u2011bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.", - "param_info": [ - { - "name": "annunciators", - "description": "The bitmasked value that shows which indicators are turned on", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "annunciators = display.getannunciators()" - ], - "overloads": [], - "examples": [ - { - "example": "testAnnunciators = display.getannunciators();print(testAnnunciators);\u00a0;rem = bit.bitand(testAnnunciators, 1024);if rem > 0 then; print(\"REM is on\");else; print(\"REM is off\");end;", - "description": "REM indicator is turned on.\n--- --Output:\n--- --1.28000e+03\n--- --REM is on\n" - }, - { - "example": "print(display.ANNUNCIATOR_EDIT);print(display.ANNUNCIATOR_TRIGGER);print(display.ANNUNCIATOR_AUTO);", - "description": "Output:\n--- --2.56000e+02\n--- --3.20000e+01\n--- --8.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bit.bitand()" - ] - }, - { - "name": "display.trigger.overrun", - "webhelpfile": "14739.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the event detector overrun status.", - "details": "Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.Indicates the overrun state of the event detector built into the display.This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = display.trigger.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = display.trigger.overrun;", - "description": "Sets the variable overrun equal to the present state of the event detector built into the display. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.trigger.clear()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "14740.htm", - "signature": "display.prompt(format, units, help, default, minimum, maximum)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prompts the user to enter a parameter from the front panel of the instrument.", - "details": "This function creates an editable input field at the present cursor position, and an input prompt message on the bottom line. Example of a displayed input field and prompt:0.00VInput 0 to +2VThe format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.The format parameter can include the options shown in the following table.You can use the minimum and maximum parameters to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.The input value is limited to \u00b11e37.After sending this command, script execution pauses for the operator to enter a value and press ENTER.For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel. Polarity also toggles when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.", - "param_info": [ - { - "name": "format", - "description": "A string that defines how the input field is formatted; see Details for more\u00a0information", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "units", - "description": "Set the units text string for the top line (eight characters maximum); this indicates the units (for example, \"V\" or \"A\") for the value", - "enum": "", - "type": "string", - "range": "(eight characters maximum)" - }, - { - "name": "help", - "description": "Text string to display on the bottom line (32 characters maximum)", - "enum": "", - "type": "string", - "range": "(32 characters maximum)" - }, - { - "name": "default", - "description": "The value that is shown when the value is first displayed", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimum", - "description": "The minimum input value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximum", - "description": "The maximum input value that can be entered (must be more than minimum)", - "enum": "", - "type": "number", - "range": "(must be more than minimum)" - } - ], - "usage": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)", - "display.prompt(format, units, help, default, minimum, maximum)" - ], - "overloads": [ - "display.prompt(format, units, help)", - "display.prompt(format, units, help, default)", - "display.prompt(format, units, help, default, minimum)" - ], - "examples": [ - { - "example": "value = display.prompt(\"0.00\", \"V\", \"Input 0 to +2V\", 0.5, 0, 2);print(value);", - "description": "The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:\n--- --0.50V\n--- --Input 0 to +2V\n--- --If the operator enters 0.70, the output is:\n--- --7.00000e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.inputvalue()" - ] - }, - { - "name": "display.screen", - "webhelpfile": "14741.htm", - "signature": "", - "command_return": "displayID", - "type": "Attribute (RW)", - "default_value": "Models 2601B/2611B/2635B:0 (display.SMUA)\nModels 2602B/2604B/2612B/2614B/2634B/2636B:2 (display.SMUA_SMUB)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the selected display screen.", - "details": "Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().Read this attribute to determine which of the available display screens was last selected.", - "param_info": [ - { - "name": "displayID", - "description": "One of the following values", - "enum": "display.SMUA nil|display.SMUB nil|display.SMUA_SMUB nil|display.USER nil", - "type": "displayscreendisplayID", - "range": "" - } - ], - "usage": [ - "displayID = display.screen", - "display.screen = displayID" - ], - "overloads": [], - "examples": [ - { - "example": "display.screen = display.SMUA;", - "description": "Selects the source-measure and compliance limit display for SMU\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "errorqueue.clear()", - "webhelpfile": "14749.htm", - "signature": "errorqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all entries out of the error queue.", - "details": "", - "param_info": [], - "usage": [ - "errorqueue.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "errorqueue.count", - "errorqueue.next()" - ] - }, - { - "name": "errorqueue.count", - "webhelpfile": "14750.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute gets the number of entries in the error queue.", - "details": "", - "param_info": [ - { - "name": "count", - "description": "The number of entries in the error queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = errorqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "count = errorqueue.count;print(count);", - "description": "Returns the number of entries in the error queue.\n--- --The output below indicates that there are four entries in the error queue:\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.next()" - ] - }, - { - "name": "eventlog.all()", - "webhelpfile": "14756.htm", - "signature": "eventlog.all()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns all entries from the event log as a single string and removes them from the event log.", - "details": "This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.This function also clears the event log.If there are no entries in the event log, this function returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "A listing of all event log entries", - "enum": "", - "type": "string|nil", - "range": "" - } - ], - "usage": [ - "logString = eventlog.all()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.all());", - "description": "Get and print all entries from the event log and remove the entries from the log.\n--- --Output:\n--- --17:26:35.690 10 Oct 2019, LAN0, 192.168.1.102, LXI, 0, 1570728395, 1192037155.733269000, 0, 0x0\n--- --17:26:39.009 10 Oct 2019, LAN5, 192.168.1.102, LXI, 0, 1570728399, 1192037159.052777000, 0, 0x0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.count", - "webhelpfile": "14757.htm", - "signature": "", - "command_return": "N", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of unread events in the event log.", - "details": "", - "param_info": [ - { - "name": "N", - "description": "The number of events in the event log", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "N = eventlog.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.count);", - "description": "Displays the present number of events in the instrument event log.\n--- --Output looks similar to:\n--- --3.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "14758.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all messages from the event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.overwritemethod", - "webhelpfile": "14759.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.DISCARD_OLDEST)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls how the event log processes events if the event log is full.", - "details": "When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.", - "param_info": [ - { - "name": "method", - "description": "Set to one of the following values", - "enum": "eventlog.DISCARD_NEWEST nil|eventlog.DISCARD_OLDEST nil", - "type": "eventlogoverwritemethodmethod", - "range": "" - } - ], - "usage": [ - "method = eventlog.overwritemethod", - "eventlog.overwritemethod = method" - ], - "overloads": [], - "examples": [ - { - "example": "eventlog.overwritemethod = 0;", - "description": "When the log is full, the event log ignores new entries.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.next()" - ] - }, - { - "name": "eventlog.enable", - "webhelpfile": "14760.htm", - "signature": "", - "command_return": "status", - "type": "Attribute (RW)", - "default_value": "1 (eventlog.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the event log.", - "details": "When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.When the event log is enabled, new events are logged.", - "param_info": [ - { - "name": "status", - "description": "The enable status of the event log", - "enum": "eventlog.ENABLE nil|eventlog.DISABLE nil", - "type": "eventlogenablestatus", - "range": "" - } - ], - "usage": [ - "status = eventlog.enable", - "eventlog.enable = status" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.enable);eventlog.enable = eventlog.DISABLE;print(eventlog.enable);", - "description": "Displays the present status of the 2600B event log.\n--- --Output:\n--- --1.00000e+00\n--- --0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.next()", - "eventlog.overwritemethod" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "14761.htm", - "signature": "eventlog.next()", - "command_return": "logString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log and removes it from the event log.", - "details": "Returns the next entry from the event log and removes it from the log.If there are no entries in the event log, returns the value nil.", - "param_info": [ - { - "name": "logString", - "description": "The next log entry", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "logString = eventlog.next()" - ], - "overloads": [], - "examples": [ - { - "example": "print(eventlog.next());", - "description": "Get the oldest message in the event log and remove that entry from the log.\n--- --Output:\n--- --17:28:22.085 10 Oct 2019, LAN2, 192.168.1.102, LXI, 0, 1570728502, , 0, 0x0\n" - }, - { - "example": "print(eventlog.next());", - "description": "If you send this command when there is nothing in the event log, you get the following output:\n--- --nil\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "eventlog.all()", - "eventlog.clear()", - "eventlog.count", - "eventlog.enable", - "eventlog.overwritemethod" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fileVar:close()", - "webhelpfile": "14772.htm", - "signature": "fileVar:close()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes the file that is represented by the fileVar variable.", - "details": "This command is equivalent to io.close(fileVar).Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to close", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:close()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"\\n*** fileVar:close\");do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();end;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");myfile:close();os.remove(fileName);", - "description": "Opens file myfile.txt for writing. If no errors were found while opening, writes Removing file and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:read()", - "fileVar:seek()", - "fileVar:write()", - "io.close()", - "io.open()" - ] - }, - { - "name": "fileVar:flush()", - "webhelpfile": "14786.htm", - "signature": "fileVar:flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffered data to a file.", - "details": "The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use fileVar:flush() to flush this data. Using this function removes the need to close a file after writing to it, allowing the file to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable to flush", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "fileVar:flush()" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Writes data to a USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.open()", - "io.write()" - ] - }, - { - "name": "fileVar:read()", - "webhelpfile": "14787.htm", - "signature": "fileVar:read(format1, ..., formatn)", - "command_return": "data1, ..., datan", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file.", - "details": "The format parameters may be any of the following:\"*n\": Returns a number.\"*a\": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).\"*l\": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.If no format parameters are provided, the function performs as if the function is passed the value \"*l\".Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "First data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "data2", - "description": "Second data read from the file", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "datan", - "description": "Last data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "fileVar", - "description": "The descriptor of the file to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the first type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the second type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatn", - "description": "A string or number indicating the last type of data to be read", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)", - "data1, ..., datan = fileVar:read(format1, ..., formatn)" - ], - "overloads": [ - "data1 = fileVar:read()\t", - "data1 = fileVar:read(format1)", - "data1, data2 = fileVar:read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;print(\"fileVar:read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");contents = myfile:read(\"*a\");print(contents);end;myfile:close();os.remove(fileName);", - "description": "Reads data from the input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:write()", - "io.input()", - "io.open()" - ] - }, - { - "name": "fileVar:seek()", - "webhelpfile": "14788.htm", - "signature": "fileVar:seek(whence, offset)", - "command_return": "position, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets and gets the present position of a file.", - "details": "The whence parameters may be any of the following:\"set\": Beginning of file\"cur\": Current position\"end\": End of fileIf an error is encountered, it is logged to the error queue, and the command returns nil and the error\u00a0string.", - "param_info": [ - { - "name": "position", - "description": "The new file position, measured in bytes from the beginning of the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "errorMsg", - "description": "A string containing the error message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "whence", - "description": "A string indicating the base against which offset is applied; the default is\u00a0\"cur\"", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "offset", - "description": "The intended new position, measured in bytes from a base indicated by whence (default is 0)", - "enum": "", - "type": "number", - "range": "(default is 0)" - } - ], - "usage": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)", - "position, errorMsg = fileVar:seek(whence, offset)" - ], - "overloads": [ - "position, errorMsg = fileVar:seek()", - "position, errorMsg = fileVar:seek(whence)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:seek\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;myfile, myfile_err, myfile_errnum = io.open(fileName, \"r\");position = myfile:seek(\"end\", -1);print(position);end;myfile:close();os.remove(fileName);", - "description": "Get the present position of a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "fileVar:write()", - "webhelpfile": "14789.htm", - "signature": "fileVar:write(data1, ..., datan)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file.", - "details": "This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.", - "param_info": [ - { - "name": "fileVar", - "description": "The file descriptor variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data", - "description": "Write all data to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data1", - "description": "The first data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "data2", - "description": "The second data to write to the file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "datan", - "description": "The last data to write to the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)", - "fileVar:write(data1, ..., datan)" - ], - "overloads": [ - "fileVar:write(data)", - "fileVar:write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** fileVar:write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");do;myfile:write(\"Line 1\");end;myfile:close();os.remove(fileName);", - "description": "Write data to a file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:close()", - "fileVar:flush()", - "io.close()", - "io.flush()", - "io.open()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "14797.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "6\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "14801.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "1 (format.LITTLEENDIAN)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.NORMAL nil|format.NETWORK nil|format.BIGENDIANL nil|format.SWAPPED nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "The output depends on the terminal program you use, but it looks something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "14803.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (format.ASCII)\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double\u2011precision format. They are alternative identifiers. Selecting which to use is a matter of preference.The IEEE Std 754 binary formats use four bytes for single\u2011precision values and eight bytes for double\u2011precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCIIS nil|format.SREAL nil|format.REAL32D nil|format.REAL nil|format.REAL64 nil|format.DREAL nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double\u2011precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return is:\n--- --/usb1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newPath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newPath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "26\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so use care when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "GPIB setup" - ] - }, - { - "name": "io.close()", - "webhelpfile": "14868.htm", - "signature": "io.close(file)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function closes a file.", - "details": "If a file is not specified, the default output file closes.Only io.close(), used without specifying a parameter, can be accessed from a remote node.", - "param_info": [ - { - "name": "file", - "description": "The descriptor of the file to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "io.close()", - "io.close(file)" - ], - "overloads": [ - "io.close()" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if nil == testError then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.flush()", - "webhelpfile": "14870.htm", - "signature": "io.flush()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves buffered data to a file.", - "details": "You must use the io.flush() or io.close() functions to write data to the file system.This function only flushes the default output file.Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.", - "param_info": [], - "usage": [ - "io.flush()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "fileVar:flush()", - "fileVar:write()", - "io.write()" - ] - }, - { - "name": "io.open()", - "webhelpfile": "14872.htm", - "signature": "io.open(path, mode)", - "command_return": "fileVar, errorMsg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file for later reference.", - "details": "The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor used to access the file.If an error is encountered, the command returns nil for fileVar and an error string.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the opened file", - "enum": "", - "type": "io_object", - "range": "" - }, - { - "name": "errorMsg", - "description": "Indicates whether an error was encountered while processing the function", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "path", - "description": "The path of the file to open", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "mode", - "description": "A string representing the intended access mode (\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)", - "enum": "", - "type": "string", - "range": "(\"r\" = read, \"w\"\u00a0=\u00a0write, and \"a\" = append)" - } - ], - "usage": [ - "fileVar, errorMsg = io.open(path)", - "fileVar, errorMsg = io.open(path, mode)" - ], - "overloads": [ - "fileVar, errorMsg = io.open(path)" - ], - "examples": [ - { - "example": "testFile, testError = io.open(\"testfile.txt\", \"w\");if testError == nil then; testFile:write(\"This is my test file\"); io.close(testFile);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes \"This is my test file\" and closes the file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.close()" - ] - }, - { - "name": "io.output()", - "webhelpfile": "14873.htm", - "signature": "io.output(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file or opens a new file as the default output file.", - "details": "The path of the file to open may be absolute or relative to the current working directory.When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the output file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A file descriptor to assign (or the path of a file to open) as the default output\u00a0file", - "enum": "", - "type": "string", - "range": "(or the path of a file to open)" - } - ], - "usage": [ - "fileVar = io.output()", - "fileVar = io.output(newfile)" - ], - "overloads": [ - "fileVar = io.output()" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.output\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);print(fileHandle);end;io.close(fileHandle);print(fileHandle);os.remove(fileName);", - "description": "Assign the file to be the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.input()", - "io.open()" - ] - }, - { - "name": "io.read()", - "webhelpfile": "14874.htm", - "signature": "io.read(format1, ..., formatN)", - "command_return": "data1, ..., dataN", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads data from the default input file.", - "details": "The format parameters may be any of the following:Any number of format parameters may be passed to this command, each corresponding to a returned data value.", - "param_info": [ - { - "name": "data1", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "data2", - "description": "The data read from the file", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "dataN", - "description": "The data read from the file; the number of return values matches the number of format values given", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "format1", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "format2", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "formatN", - "description": "A string or number indicating the type of data to be read", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "...", - "description": "One or more entries (or values) separated by commas", - "enum": "", - "type": "any", - "range": "(or values)" - } - ], - "usage": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)", - "data1, ..., dataN = io.read(format1, ..., formatN)" - ], - "overloads": [ - "data1 = io.read()", - "data1 = io.read(format1)", - "data1, data2 = io.read(format1, format2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;-- io.read;print(\"\\n*** io.read\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\\n\");myfile:flush();myfile:close();do;fileHandle = io.input(fileName);value = io.read(\"*a\");print(value);end;fileHandle:close();\u00a0;print(errorqueue.next());", - "description": "Read data from the default input file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "io.type()", - "webhelpfile": "14875.htm", - "signature": "io.type(obj)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks whether or not a given object is a file handle.", - "details": "Returns the string \"file\" if the object is an open file handle. If it is not an open file handle, nil is returned.", - "param_info": [ - { - "name": "type", - "description": "Indicates whether the object is an open file handle", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "obj", - "description": "Object to check", - "enum": "", - "type": "file_object", - "range": "" - } - ], - "usage": [ - "type = io.type(obj)" - ], - "overloads": [], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.type\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);state = io.type(fileHandle);print(state);end;io.close(fileHandle);local state = io.type(fileHandle);print(state);os.remove(fileName);", - "description": "Check whether or not fileName is a file handle.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()" - ] - }, - { - "name": "io.write()", - "webhelpfile": "14877.htm", - "signature": "io.write(data1, ..., dataN)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the default output file.", - "details": "All data parameters must be either strings or numbers.", - "param_info": [ - { - "name": "data1", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "data2", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "dataN", - "description": "The data to be written", - "enum": "", - "type": "string|number", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated by commas", - "enum": "", - "type": "string|number", - "range": "" - } - ], - "usage": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)", - "io.write(data1, ..., dataN)" - ], - "overloads": [ - "io.write()", - "io.write(data1)", - "io.write(data1, data2)" - ], - "examples": [ - { - "example": "local fileName = \"/usb1/myfile.txt\";\u00a0;if fs.is_file(fileName) then;\tos.remove(fileName);\tprint(\"Removing file\");else;\tprint(\"Nothing removed\");end;\u00a0;errorqueue.clear();\u00a0;print(\"\\n*** io.write\");myfile, myfile_err, myfile_errnum = io.open(fileName, \"w\");myfile:write(\"Line 1\");myfile:close();do;fileHandle = io.output(fileName);io.write(\"Line 2\");end;io.close(fileHandle);os.remove(fileName);", - "description": "Writes data to the default output file.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.flush()" - ] - }, - { - "name": "lan.applysettings()", - "webhelpfile": "14890.htm", - "signature": "lan.applysettings()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function re-initializes the LAN interface with new settings.", - "details": "Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the present configuration\u00a0settings.This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization continues to run in the background.Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the\u00a0LAN.", - "param_info": [ - { - "name": "lan.applysettings()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Re-initialize the LAN interface with new settings.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lan.applysettings()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.applysettings();", - "description": "Re-initialize the LAN interface with new settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.autoconnect", - "webhelpfile": "14891.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute is used to enable or disable link monitoring.", - "details": "This attribute sets the LAN link monitoring and automatic connection state.When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.", - "param_info": [ - { - "name": "state", - "description": "LAN link monitoring state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanautoconnectstate", - "range": "" - } - ], - "usage": [ - "state = lan.autoconnect", - "lan.autoconnect = state" - ], - "overloads": [], - "examples": [ - { - "example": "lan.autoconnect = lan.ENABLE;", - "description": "Enable LAN link monitoring.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.linktimeout", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.linktimeout", - "webhelpfile": "14892.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN link timeout period.", - "details": "You must enable the command lan.autoconnect before you can use this attribute.The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN link monitor time-out period (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - } - ], - "usage": [ - "timeout = lan.linktimeout ", - "lan.linktimeout = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.linktimeout);", - "description": "Outputs the present LAN link timeout setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.autoconnect", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.nagle", - "webhelpfile": "14894.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (lan.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the state of the LAN Nagle algorithm.", - "details": "This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.", - "param_info": [ - { - "name": "state", - "description": "The state of the Nagle algorithm", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lannaglestate", - "range": "" - } - ], - "usage": [ - "state = lan.nagle", - "lan.nagle = state" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.reset()", - "webhelpfile": "14895.htm", - "signature": "lan.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the LAN interface.", - "details": "This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings(). It also resets the LAN password.", - "param_info": [], - "usage": [ - "lan.reset()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.applysettings()", - "lan.restoredefaults()", - "localnode.password" - ] - }, - { - "name": "lan.restoredefaults()", - "webhelpfile": "14896.htm", - "signature": "lan.restoredefaults()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets LAN settings to default values.", - "details": "The settings that are restored are shown in the following table.This command is run when lan.reset() is sent.", - "param_info": [], - "usage": [ - "lan.restoredefaults()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.restoredefaults();", - "description": "Restores the LAN defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.password" - ] - }, - { - "name": "lan.timedwait", - "webhelpfile": "14897.htm", - "signature": "", - "command_return": "timeout", - "type": "Attribute (RW)", - "default_value": "20 (20 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN timed-wait state interval.", - "details": "This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is\u00a0closed.Use this attribute to tailor the timed-wait state interval for the instrument.", - "param_info": [ - { - "name": "timeout", - "description": "The LAN timed-wait state interval in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timeout = lan.timedwait", - "lan.timedwait = timeout" - ], - "overloads": [], - "examples": [ - { - "example": "lan.timedwait = 30;", - "description": "Set the amount of time resources are allocated to TCP connection to 30\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.address[N]", - "webhelpfile": "14898.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "Configures DNS server IP addresses.", - "details": "This attribute is an array of Domain Name System (DNS) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP\u2011configured global DNS servers.You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups. dnsAddress must be a string specifying the IP address of the DNS server in dotted decimal notation.Unused entries are returned as \"0.0.0.0\" when read. To disable an entry, set its value to \"0.0.0.0\" or the empty string\u00a0\"\".Although only two addresses may be manually specified here, the instrument uses up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "dnsAddress = lan.config.dns.address[N]", - "lan.config.dns.address[N] = dnsAddress" - ], - "overloads": [], - "examples": [ - { - "example": "dnsaddress = \"164.109.48.173\";lan.config.dns.address[1] = dnsaddress;", - "description": "Set the DNS address 1 to 164.109.48.173.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.domain", - "webhelpfile": "14899.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "Configures the dynamic DNS domain.", - "details": "This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.", - "param_info": [ - { - "name": "domain", - "description": "Dynamic DNS registration domain; use a string of 255 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "domain = lan.config.dns.domain", - "lan.config.dns.domain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.domain);", - "description": "Outputs the present dynamic DNS domain. For example, if the domain is \"Matrix\", the response is:\n--- --Matrix\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.dynamic", - "lan.config.dns.hostname", - "lan.config.dns.verify", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.dynamic", - "webhelpfile": "14900.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "Enables or disables the dynamic DNS registration.", - "details": "Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.", - "param_info": [ - { - "name": "state", - "description": "The dynamic DNS registration state. It may be one of the following values", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsdynamicstate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.dynamic", - "lan.config.dns.dynamic = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.dynamic);", - "description": "Outputs the dynamic registration state.\n--- --If dynamic DNS registration is enabled, the response is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.dns.verify", - "webhelpfile": "14902.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "1 (lan.ENABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the DNS host name verification state.", - "details": "When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.", - "param_info": [ - { - "name": "state", - "description": "DNS hostname verification state", - "enum": "lan.ENABLE nil|lan.DISABLE nil", - "type": "lanconfigdnsverifystate", - "range": "" - } - ], - "usage": [ - "state = lan.config.dns.verify", - "lan.config.dns.verify = state" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.verify);", - "description": "Outputs the present DNS host name verification state.\n--- --If it is enabled, the output is:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.hostname", - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.duplex", - "webhelpfile": "14903.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (RW)", - "default_value": "1 (lan.FULL)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the LAN duplex mode.", - "details": "This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.FULL nil|lan.HALF nil", - "type": "lanconfigduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.config.duplex", - "lan.config.duplex = duplex" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.duplex = lan.FULL;", - "description": "Set the LAN duplex mode to full.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.gateway", - "webhelpfile": "14904.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN default gateway address.", - "details": "This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.gateway attribute to determine the present operating state of the\u00a0LAN.The IP address must be formatted in four groups of numbers, each separated by a\u00a0decimal.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN default gateway address; must be a string specifying the default IP address of the gateway in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.config.gateway", - "lan.config.gateway = gatewayAddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.gateway);", - "description": "Outputs the default gateway address. For example, you might see the output:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.gateway" - ] - }, - { - "name": "lan.config.ipaddress", - "webhelpfile": "14905.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"192.168.0.2\"\n", - "tsp_link": "Yes\n", - "description": "This command specifies the LAN IP address.", - "details": "This command specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used. This attribute does not indicate the actual setting that is presently in effect. Use the lan.status.ipaddress attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.config.ipaddress", - "lan.config.ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "ipaddress = lan.config.ipaddress;", - "description": "Retrieves the presently set LAN IP address.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.ipaddress" - ] - }, - { - "name": "lan.config.method", - "webhelpfile": "14906.htm", - "signature": "", - "command_return": "method", - "type": "Attribute (RW)", - "default_value": "0 (lan.AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN settings configuration method.", - "details": "This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are\u00a0determined.When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified\u00a0settings.When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.AUTO nil|lan.MANUAL nil", - "type": "lanconfigmethodmethod", - "range": "" - } - ], - "usage": [ - "method = lan.config.method", - "lan.config.method = method" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.method);", - "description": "Outputs the present method.\n--- --For example:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()" - ] - }, - { - "name": "lan.config.speed", - "webhelpfile": "14907.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (RW)", - "default_value": "100 (100 Mbps)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed used when restarting in manual configuration mode.", - "details": "This attribute stores the speed that is used if the LAN is restarted for manual configuration operation.This attribute does not indicate the actual setting presently in effect. Use the lan.status.speed attribute to determine the present operating state of the LAN.The LAN speed is measured in megabits per second (Mbps).", - "param_info": [ - { - "name": "speed", - "description": "LAN speed setting in Mbps (10 or 100)", - "enum": "", - "type": "number", - "range": "(10 or 100)" - } - ], - "usage": [ - "speed = lan.config.speed", - "lan.config.speed = speed" - ], - "overloads": [], - "examples": [ - { - "example": "lan.config.speed = 100;", - "description": "Configure LAN speed for 100.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.speed" - ] - }, - { - "name": "lan.config.subnetmask", - "webhelpfile": "14908.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "\"255.255.255.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask.", - "details": "This attribute specifies the LAN subnet mask that is used when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.This attribute does not indicate the actual setting presently in effect. Use the lan.status.subnetmask attribute to determine the present operating state of the LAN.", - "param_info": [ - { - "name": "mask", - "description": "String that specifies the LAN subnet mask value in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.config.subnetmask", - "lan.config.subnetmask = mask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.subnetmask);", - "description": "Outputs the LAN subnet mask, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.restoredefaults()", - "lan.status.subnetmask" - ] - }, - { - "name": "lan.status.dns.address[N]", - "webhelpfile": "14909.htm", - "signature": "", - "command_return": "dnsAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the DNS server IP addresses.", - "details": "This attribute is an array of DNS server addresses. The instrument can use up to three addresses.Unused or disabled entries are returned as \"0.0.0.0\" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.", - "param_info": [ - { - "name": "dnsAddress", - "description": "DNS server IP address", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Entry index (1, 2, or 3)", - "enum": "", - "type": "any", - "range": "(1, 2, or 3)" - } - ], - "usage": [ - "dnsAddress = lan.status.dns.address[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.address[1]);", - "description": "Outputs DNS server address 1, for\u00a0example:\n--- --164.109.48.173\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.status.dns.name" - ] - }, - { - "name": "lan.status.dns.name", - "webhelpfile": "14910.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the present DNS fully qualified host name.", - "details": "A fully qualified domain name (FQDN) specifies its exact location in the tree hierarchy of the Domain Name System (DNS).A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: The host name and the domain name.If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.", - "param_info": [ - { - "name": "hostName", - "description": "Fully qualified DNS host name that can be used to connect to the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.status.dns.name" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.dns.name);", - "description": "Outputs the dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.address[N]", - "lan.config.dns.hostname" - ] - }, - { - "name": "lan.status.duplex", - "webhelpfile": "14911.htm", - "signature": "", - "command_return": "duplex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the duplex mode presently in use by the LAN interface.", - "details": "", - "param_info": [ - { - "name": "duplex", - "description": "LAN duplex setting can be one of the following values", - "enum": "lan.HALF nil|lan.FULL nil", - "type": "lanstatusduplexduplex", - "range": "" - } - ], - "usage": [ - "duplex = lan.status.duplex" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.duplex);", - "description": "Outputs the present LAN duplex mode, such as:\n--- --1.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.gateway", - "webhelpfile": "14912.htm", - "signature": "", - "command_return": "gatewayAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the gateway address presently in use by the LAN interface.", - "details": "The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.", - "param_info": [ - { - "name": "gatewayAddress", - "description": "LAN gateway address presently being used", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "gatewayAddress = lan.status.gateway" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.gateway);", - "description": "Outputs the gateway address, such as:\n--- --192.168.0.1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.gateway" - ] - }, - { - "name": "lan.status.ipaddress", - "webhelpfile": "14913.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN IP address presently in use by the LAN interface.", - "details": "The IP address is a character string that represents the IP address assigned to the instrument.", - "param_info": [ - { - "name": "ipAddress", - "description": "LAN IP address specified in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "ipAddress = lan.status.ipaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.ipaddress);", - "description": "Outputs the LAN IP address currently in use, such as:\n--- --192.168.0.2\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.ipaddress" - ] - }, - { - "name": "lan.status.macaddress", - "webhelpfile": "14914.htm", - "signature": "", - "command_return": "macAddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets (see\u00a0Example).", - "param_info": [ - { - "name": "macAddress", - "description": "The instrument MAC address", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "macAddress = lan.status.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.macaddress);", - "description": "Outputs the MAC address of the instrument, for example:\n--- --08:00:11:00:00:57\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.dst", - "webhelpfile": "14915.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN dead socket termination port number.", - "details": "This attribute holds the TCP port number used to reset all other LAN socket connections.To reset all LAN connections, open a connection to the DST port number.", - "param_info": [ - { - "name": "port", - "description": "Dead socket termination socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.dst" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.dst);", - "description": "Outputs the LAN dead socket termination port number, such\u00a0as:\n--- --5.03000e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.rawsocket", - "webhelpfile": "14916.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN raw socket connection port number.", - "details": "The TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.", - "param_info": [ - { - "name": "port", - "description": "Raw socket port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.rawsocket" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.rawsocket);", - "description": "Outputs the LAN raw socket port number, such\u00a0as:\n--- --5.02500e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.telnet", - "webhelpfile": "14917.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN Telnet connection port number.", - "details": "This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.", - "param_info": [ - { - "name": "port", - "description": "Telnet port number", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.telnet" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.telnet);", - "description": "Get the LAN Telnet connection port number.\n--- --Output:\n--- --2.30000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.port.vxi11", - "webhelpfile": "14918.htm", - "signature": "", - "command_return": "port", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN VXI-11 connection port number.", - "details": "This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.", - "param_info": [ - { - "name": "port", - "description": "LAN VXI-11 port number", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "port = lan.status.port.vxi11" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.port.vxi11);", - "description": "Outputs the VXI-11 number, such as:\n--- --1.02400e+03\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.speed", - "webhelpfile": "14919.htm", - "signature": "", - "command_return": "speed", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN speed.", - "details": "This attribute indicates the transmission speed currently in use by the LAN interface.", - "param_info": [ - { - "name": "speed", - "description": "LAN speed in Mbps, either 10 or 100", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "speed = lan.status.speed" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.speed);", - "description": "Outputs the transmission speed of the instrument presently in use, such as:\n--- --1.00000e+02\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.status.subnetmask", - "webhelpfile": "14920.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN subnet mask that is presently in use by the LAN interface.", - "details": "Use this attribute to determine the present operating state of the LAN. This attribute returns the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.", - "param_info": [ - { - "name": "mask", - "description": "A string specifying the subnet mask in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "mask = lan.status.subnetmask" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.status.subnetmask);", - "description": "Outputs the subnet mask of the instrument that is presently in use, such as:\n--- --255.255.255.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.subnetmask" - ] - }, - { - "name": "lan.trigger[N].assert()", - "webhelpfile": "14921.htm", - "signature": "lan.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].assert();", - "description": "Creates a trigger with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.lxidomain", - "lan.trigger[N].clear()", - "lan.trigger[N].mode", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()", - "Understanding hardware value and pseudo line state" - ] - }, - { - "name": "lan.trigger[N].clear()", - "webhelpfile": "14922.htm", - "signature": "lan.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].clear();", - "description": "Clears the event detector with LAN packet 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connect()", - "webhelpfile": "14923.htm", - "signature": "lan.trigger[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;lan.trigger[1].connect();lan.trigger[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].overrun", - "lan.trigger[N].protocol", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].connected", - "webhelpfile": "14924.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the LAN event connection state.", - "details": "This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = lan.trigger[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[1].protocol = lan.MULTICAST;print(lan.trigger[1].connected);", - "description": "Outputs true if connected, or false if not\u00a0connected.\n--- --Example output:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].disconnect()", - "webhelpfile": "14925.htm", - "signature": "lan.trigger[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger.", - "details": "For TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "lan.trigger[N].disconnect()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].ipaddress", - "lan.trigger[N].protocol" - ] - }, - { - "name": "lan.trigger[N].EVENT_ID", - "webhelpfile": "14926.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).", - "details": "Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = lan.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID;", - "description": "Route occurrences of triggers on LAN trigger\u00a01 to digital I/O trigger\u00a014.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].ipaddress", - "webhelpfile": "14927.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted\u2011decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.Set to \"0.0.0.0\" for multicast.After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = lan.trigger[N].ipaddress", - "lan.trigger[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[3].protocol = lan.TCP;lan.trigger[3].ipaddress = \"192.168.1.100\";lan.trigger[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be lan.TCP when sending LAN triggers.\n--- --Use IP address \"192.168.1.100\" to connect the LAN trigger.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()" - ] - }, - { - "name": "lan.trigger[N].mode", - "webhelpfile": "14928.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (lan.TRIG_EITHER)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.lan.TRIG_RISING and lan.TRIG_RISINGA are the same.lan.TRIG_RISING and lan.TRIG_RISINGM are the same.Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM instead of lan.TRIG_SYNCHRONOUS is preferred. Use of lan.TRIG_SYNCHRONOUS is provided for compatibility with older products and other Keithley Instruments products.", - "param_info": [ - { - "name": "mode", - "description": "A number representing the trigger mode (0 to 7); see the Details section for more\u00a0information", - "enum": "", - "type": "lanTriggerMode", - "range": "(0 to 7)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "mode = lan.trigger[N].mode", - "lan.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].mode);", - "description": "Outputs the present LAN trigger mode of LAN event\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "lan.trigger[N].overrun", - "webhelpfile": "14929.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = lan.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = lan.trigger[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].stimulus", - "lan.trigger[N].wait()" - ] - }, - { - "name": "lan.trigger[N].protocol", - "webhelpfile": "14930.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "0 (lan.TCP)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be\u00a0sent.When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.TCP1 nil|lan.UDP2 nil|lan.MULTICAST nil", - "type": "lantriggerprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = lan.trigger[N].protocol", - "lan.trigger[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].protocol);", - "description": "Get LAN protocol to use for sending trigger messages for LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].connect()", - "lan.trigger[N].ipaddress" - ] - }, - { - "name": "lan.trigger[N].pseudostate", - "webhelpfile": "14931.htm", - "signature": "", - "command_return": "pseudostate", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated line state for the LAN trigger.", - "details": "This attribute can be set to initialize the pseudo line state to a known value.Setting this attribute does not cause the LAN trigger to generate any events or output packets.", - "param_info": [ - { - "name": "pseudostate", - "description": "The simulated line state (0 or 1)", - "enum": "", - "type": "0|1", - "range": "(0 or 1)" - }, - { - "name": "N", - "description": "A number representing the LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "pseudostate = lan.trigger[N].pseudostate", - "lan.trigger[N].pseudostate = pseudostate" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.trigger[1].pseudostate);", - "description": "Get the present simulated line state for the LAN event 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "lan.trigger[N].wait()", - "webhelpfile": "14933.htm", - "signature": "lan.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = lan.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = lan.trigger[5].wait(3);", - "description": "Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].overrun", - "lan.trigger[N].stimulus" - ] - }, - { - "name": "localnode.autolinefreq", - "webhelpfile": "15007.htm", - "signature": "", - "command_return": "flag", - "type": "Attribute (RW)", - "default_value": "true (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic power line frequency detection at start\u2011up.", - "details": "When this attribute is set to true, the power line frequency is detected automatically the next time the 2600B powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute is set automatically to 50 or 60.If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq is automatically set to false.When using this command from a remote node, replace localnode with the node reference, for example node[5].autolinefreq.", - "param_info": [ - { - "name": "flag", - "description": "The auto line frequency detection setting", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "flag = localnode.autolinefreq", - "localnode.autolinefreq = flag" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.linefreq" - ] - }, - { - "name": "localnode.description", - "webhelpfile": "15008.htm", - "signature": "", - "command_return": "description", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a user-defined description and mDNS service name of the instrument.", - "details": "This attribute stores a string that contains a description of the instrument. This value appears on LXI welcome page of the instrument. The value of this attribute is also used as the mDNS service name of the instrument.The factory default value of this attribute is \"Keithley Instruments SMU - \", where and are replaced with the actual model number and serial number of the instrument. Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string consisting entirely of whitespace characters) reverts the description to the factory default value.When using this command from a remote node, replace localnode with the node reference, for example node[5].description.", - "param_info": [ - { - "name": "description", - "description": "User-defined description and mDNS service name of the instrument; use a string of 63 characters or less", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.description = description", - "description = localnode.description" - ], - "overloads": [], - "examples": [ - { - "example": "description = \"System in Lab 05\";localnode.description = description;", - "description": "Set description to System in Lab 05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function retrieves the value of a global variable from the runtime environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].setglobal()", - "TSP advanced features" - ] - }, - { - "name": "gettimezone()", - "webhelpfile": "15011.htm", - "signature": "gettimezone()", - "command_return": "timeZone", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the local time zone.", - "details": "See settimezone() for additional details about the time zone format and a description of the fields.timeZone can be in either of the following formats:", - "param_info": [ - { - "name": "timeZone", - "description": "The local time zone of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "timeZone = gettimezone()" - ], - "overloads": [], - "examples": [ - { - "example": "timezone = gettimezone();", - "description": "Reads the value of the local time zone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settimezone()" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "15012.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (RW)", - "default_value": "60 (60 Hz)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50\u00a0Hz or 60\u00a0Hz) of the ac power\u00a0line. When using this command from a remote node, replace localnode with the node reference, for example node[5].linefreq. When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the ac power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.", - "param_info": [ - { - "name": "frequency", - "description": "An integer representing the detected or specified line frequency of the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq", - "localnode.linefreq = frequency" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;", - "description": "Reads line frequency setting.\n" - }, - { - "example": "localnode.linefreq = 60;", - "description": "Sets the line frequency to 60\u00a0Hz.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.autolinefreq" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --2602B\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "15014.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the remote access password.", - "details": "This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply a password to change the configuration or to control an instrument from a remote command interface.The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.You cannot retrieve a lost password from any command interface.You can reset the password by resetting the LAN from the front panel or by sending the lan.reset() command.When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].password.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the remote interface password, up to 255 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the remote interface password to N3wpa55w0rd.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.reset()", - "localnode.passwordmode" - ] - }, - { - "name": "localnode.passwordmode", - "webhelpfile": "15015.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "1 (localnode.PASSWORD_WEB)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password enable mode for remote access to the instrument.", - "details": "This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:When using this command from a remote node, replace localnode with the node reference, for example node[5].passwordmode.If you enable password mode, you must also assign a password.", - "param_info": [ - { - "name": "mode", - "description": "The remote password enable mode 0 or localnode.PASSWORD_NONE", - "enum": "localnode.PASSWORD_NONE nil|localnode.PASSWORD_WEB nil|localnode.PASSWORD_LAN nil|localnode.PASSWORD_ALL nil", - "type": "localnodepasswordmodemode", - "range": "" - } - ], - "usage": [ - "mode = localnode.passwordmode", - "localnode.passwordmode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "mode = localnode.PASSWORD_WEB;localnode.passwordmode = mode;localnode.password = \"SMU1234\";", - "description": "Sets value of mode to PASSWORD_WEB.\n--- --Allows use of passwords on the web interface only.\n--- --Set the password to SMU1234.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "15016.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they are not enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Prompting mode", - "enum": "", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = 1;", - "description": "Enable prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.reset()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "15017.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands do not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = 0;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "localnode.revision", - "webhelpfile": "15018.htm", - "signature": "", - "command_return": "revision", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware revision level.", - "details": "This attribute indicates the revision number of the firmware that is presently running in the instrument.When using this command from a remote node, replace localnode with the node reference. For example, node[5].revision.", - "param_info": [ - { - "name": "revision", - "description": "Firmware revision level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "revision = localnode.revision" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.revision);", - "description": "Outputs the present revision level.\n--- --Sample output:\n--- --1.0.0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "15019.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the serial number of the instrument.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(localnode.serialno);", - "description": "Clears the instrument display.\n--- --Places the serial number of the instrument on the top line of its display.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.description", - "localnode.model", - "localnode.revision" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "node[N].getglobal()", - "TSP advanced features" - ] - }, - { - "name": "settimezone()", - "webhelpfile": "15021.htm", - "signature": "settimezone(offset, dstOffset, dstStart, dstEnd)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the local time zone.", - "details": "You only need to set the time zone if you use the os.time() and os.date() functions. If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.offset and dstOffset are strings of the form \"[+|-]hh[:mm[:ss]]\" that indicate how much time must be added to the local time to get UTC time:The minute, second, +, and \u2212 fields are optional.For example, to set the UTC-5 time zone, you specify the string \"5\", because UTC-5 is 5 hours behind UTC and you must add 5 hours to the local time to determine UTC time. To specify the time zone UTC4, you specify \"-4\", because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to determine UTC.dstStart and dstEnd are strings of the form \"MM.w.dw/hh[:mm[:ss]]\" that indicate when daylight savings time begins and ends respectively:The rest of the fields represent the time of day that the change takes effect:The minutes and seconds fields are optional.The week of the month and day of the week fields are not specific dates.", - "param_info": [ - { - "name": "offset", - "description": "String representing offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstOffset", - "description": "String representing the daylight savings offset from UTC", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstStart", - "description": "String representing when daylight savings time starts", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "dstEnd", - "description": "String representing when daylight savings time ends", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "settimezone(offset)", - "settimezone(offset, dstOffset, dstStart, dstEnd)" - ], - "overloads": [ - "settimezone(offset)" - ], - "examples": [ - { - "example": "settimezone(\"8\", \"1\", \"3.3.0/02\", \"11.2.0/02\")settimezone(offset);", - "description": "Sets offset to equal +8 hours, +1\u00a0hour for DST, starts on Mar 14 at 2:00\u00a0am, ends on Nov 7 at 2:00 am.\n--- --Sets local time zone to offset.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "gettimezone()", - "os.time()", - "settime()" - ] - }, - { - "name": "localnode.showerrors", - "webhelpfile": "15022.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not the instrument automatically sends generated errors.", - "details": "If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt if prompts are enabled).If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.When using this command from a remote node, replace localnode with the node reference, for example, node[5].showerrors.", - "param_info": [ - { - "name": "errorMode", - "description": "Show error setting", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showerrors", - "localnode.showerrors = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showerrors = 1;", - "description": "Enables sending of generated errors.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "makegetter()", - "webhelpfile": "15041.htm", - "signature": "makegetter(table, attributeName)", - "command_return": "getter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function to get the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes more quickly than accessing the attribute directly.Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.", - "param_info": [ - { - "name": "getter", - "description": "The return value", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read\u2011only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "A string representing the name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "getter = makegetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "getlevel = makegetter(smua.source, \"levelv\");v = getlevel();", - "description": "Creates a getter function called getlevel.\n--- --When getlevel() is called, it returns the value of smua.source.levelv. \n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makesetter()" - ] - }, - { - "name": "makesetter()", - "webhelpfile": "15042.htm", - "signature": "makesetter(table, attributeName)", - "command_return": "setter", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a function that, when called, sets the value of an attribute.", - "details": "This function is useful for aliasing attributes to improve execution speed. Calling the setter function execute more quickly than accessing the attribute directly.Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ", - "param_info": [ - { - "name": "setter", - "description": "Function that sets the value of the attribute", - "enum": "", - "type": "function", - "range": "" - }, - { - "name": "table", - "description": "Read-only table where the attribute is located", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "attributeName", - "description": "The string name of the attribute", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "setter = makesetter(table, attributeName)" - ], - "overloads": [], - "examples": [ - { - "example": "setlevel = makesetter(smua.source, \"levelv\")for v = 1, 10 do; setlevel(v);end;", - "description": "Creates a setter function called setlevel.\n--- --Using setlevel() in the loop sets the value of smua.source.levelv, performing a source sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "makegetter()" - ] - }, - { - "name": "meminfo()", - "webhelpfile": "15050.htm", - "signature": "meminfo()", - "command_return": "freeMem, totalMem", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns the present amount of available memory and the total amount of memory in the instrument.", - "details": "This function returns two values:The difference between the two values is the amount presently used.", - "param_info": [ - { - "name": "freeMem", - "description": "The amount of free dynamically allocated memory available", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "totalMem", - "description": "The total amount of dynamically allocated memory in the instrument", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "freeMem, totalMem = meminfo()" - ], - "overloads": [], - "examples": [ - { - "example": "print(meminfo());", - "description": "Retrieve the amount of free and total memory in the\u00a0instrument.\n--- --Output:\n--- --2.89840e+04\t3.27680e+04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "15054.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete status bit when all overlapped commands are completed.", - "details": "This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output:1", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model", - "waitcomplete()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "15063.htm", - "signature": "script.load(file, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path \"/usb1/\". Both the forward slash (/) and backslash (\\) are supported as directory separators.The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.Script naming:", - "param_info": [ - { - "name": "scriptVar", - "description": "The created script; this is nil if an error is encountered", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "file", - "description": "The path and file name of the script file to load", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script to be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.load(file)", - "scriptVar = script.load(file, name)" - ], - "overloads": [ - "scriptVar = script.load(file)" - ], - "examples": [ - { - "example": "myTest8 = script.load(\"/usb1/filename.tsp\", \"myTest8\");", - "description": "Loads the script myTest8 from the USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.new()" - ] - }, - { - "name": "script.new()", - "webhelpfile": "15064.htm", - "signature": "script.new(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string containing the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.new(code)", - "scriptVar = script.new(code, name)" - ], - "overloads": [ - "scriptVar = script.new(code)" - ], - "examples": [ - { - "example": "myTest8 = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0myTest8')\", \"myTest8\");myTest8();", - "description": "Creates a new script referenced by the variable myTest8 with the name myTest8.\n--- --Runs the script. The instrument displays Hello from myTest8.\n" - }, - { - "example": "autoexec = script.new(; \"display.clear() display.settext('Hello\u00a0from\u00a0autoexec')\", 'autoexec');", - "description": "Creates a new autoexec script that clears the display when the instrument is turned on and displays Hello from autoexec.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "scriptVar.save()", - "script.newautorun()" - ] - }, - { - "name": "serial.baud", - "webhelpfile": "15068.htm", - "signature": "", - "command_return": "baud", - "type": "Attribute (RW)", - "default_value": "9600\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the baud rate for the RS-232 port.", - "details": "A new baud rate setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "baud", - "description": "The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)", - "enum": "", - "type": "number", - "range": "(300, 600, 1200, 2400, 4800, 9600, 19200, 38400,\u00a057600,\u00a0or\u00a0115200)" - } - ], - "usage": [ - "baud = serial.baud", - "serial.baud = baud" - ], - "overloads": [], - "examples": [ - { - "example": "serial.baud = 1200;", - "description": "Sets the baud rate to 1200.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.databits", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.databits", - "webhelpfile": "15069.htm", - "signature": "", - "command_return": "bits", - "type": "Attribute (RW)", - "default_value": "8\n", - "tsp_link": "Yes\n", - "description": "This attribute configures character width (data bits) for the RS-232 port.", - "details": "A new data width setting takes effect when the command to change it is processed.The reset function has no effect on data bits.", - "param_info": [ - { - "name": "bits", - "description": "An integer representing the character width (7 or 8)", - "enum": "", - "type": "number", - "range": "(7 or 8)" - } - ], - "usage": [ - "bits = serial.databits", - "serial.databits = bits" - ], - "overloads": [], - "examples": [ - { - "example": "serial.databits = 8;", - "description": "Sets data width to 8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.flowcontrol", - "serial.parity" - ] - }, - { - "name": "serial.flowcontrol", - "webhelpfile": "15070.htm", - "signature": "", - "command_return": "flow", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.FLOW_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures flow control for the RS-232 port.", - "details": "A new flow control setting takes effect when the command to change it is processed.The reset function has no effect on flow control.", - "param_info": [ - { - "name": "flow", - "description": "A string or value that represents flow control configuration; set to", - "enum": "serial.FLOW_NONE nil|serial.FLOW_HARDWARE nil", - "type": "serialflowcontrolflow", - "range": "" - } - ], - "usage": [ - "flow = serial.flowcontrol", - "serial.flowcontrol = flow" - ], - "overloads": [], - "examples": [ - { - "example": "serial.flowcontrol = serial.FLOW_NONE;", - "description": "Sets flow control to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.baud", - "serial.databits", - "serial.parity" - ] - }, - { - "name": "serial.parity", - "webhelpfile": "15071.htm", - "signature": "", - "command_return": "parity", - "type": "Attribute (RW)", - "default_value": "\"none\" (serial.PARITY_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures parity for the RS-232 port.", - "details": "A new parity setting takes effect when the command to change it is processed.The reset function has no effect on parity.", - "param_info": [ - { - "name": "parity", - "description": "Set parity to one of the following values", - "enum": "serial.PARITY_NONE nil|serial.PARITY_EVEN nil|serial.PARITY_ODD nil", - "type": "serialparityparity", - "range": "" - } - ], - "usage": [ - "parity = serial.parity", - "serial.parity = parity" - ], - "overloads": [], - "examples": [ - { - "example": "serial.parity = serial.PARITY_NONE;", - "description": "Sets parity to none.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "RS-232 interface operation", - "serial.baud", - "serial.databits", - "serial.flowcontrol" - ] - }, - { - "name": "serial.read()", - "webhelpfile": "15072.htm", - "signature": "serial.read(maxchars)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads available characters (data) from the serial port.", - "details": "This function reads available characters from the serial port. It does not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters that are received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers overflow and some characters may be lost.Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted.If you attempt to use this function when the serial port is enabled as a command interface, a settings conflict error is generated.", - "param_info": [ - { - "name": "data", - "description": "A string that consists of all data read from the serial port", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "maxchars", - "description": "An integer that specifies the maximum number of characters to read", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = serial.read(maxchars)" - ], - "overloads": [], - "examples": [ - { - "example": "data = serial.read(200);\u00a0;print(data);", - "description": "Read data from the serial port.\n--- --Output:\n--- --John Doe\n--- --The above output indicates that the string \"John Doe\" was read from the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.write()" - ] - }, - { - "name": "serial.write()", - "webhelpfile": "15073.htm", - "signature": "serial.write(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes data to the serial port.", - "details": "This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). No terminator characters are added to the data, and data is written exactly as specified by the data parameter.", - "param_info": [ - { - "name": "data", - "description": "A string representing the data to write", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serial.write(data)" - ], - "overloads": [], - "examples": [ - { - "example": "serial.write(\"1 2 3 4\");", - "description": "Write data string \"1 2 3 4\" to the serial port.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "serial.read()" - ] - }, - { - "name": "setup.poweron", - "webhelpfile": "15081.htm", - "signature": "", - "command_return": "id", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which saved setup to recall when the instrument is turned on.", - "details": "When id = 0, the instrument uses the factory default setup when it is turned on. When id is set to 1 to 5, it uses the setup saved with setup.save().Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command).To save a script that is used when the instrument is powered on, you can create a configuration script and name it autoexec.", - "param_info": [ - { - "name": "id", - "description": "An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)", - "enum": "", - "type": "integer", - "range": "(0 to 5)" - } - ], - "usage": [ - "id = setup.poweron", - "setup.poweron = id" - ], - "overloads": [], - "examples": [ - { - "example": "setup.poweron = 0;", - "description": "Set the instrument to use the factory default setup when power is turned on.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "setup.save() ", - "Start-up (power-on) configuration" - ] - }, - { - "name": "setup.save()", - "webhelpfile": "15083.htm", - "signature": "setup.save(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the present setup as a user-saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to save to the nonvolatile memory of the instrument.When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.", - "param_info": [ - { - "name": "id", - "description": "An integer or string specifying where to save the user setup", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.save(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.save(5);", - "description": "Saves the present setup to the internal memory of the instrument at location 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.recall()" - ] - }, - { - "name": "smua.abort()", - "webhelpfile": "15088.htm", - "signature": "smua.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smub.abort()", - "webhelpfile": "15088.htm", - "signature": "smub.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function terminates all overlapped operations on the specified source\u2011measure unit (SMU).", - "details": "The smuX.abort() function does not turn the output off or change any settings.If this function is used to abort a sweep, when it is executed, the SMU exits its trigger model immediately and returns to the idle state of the trigger model.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.abort() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.abort();", - "description": "Terminates all overlapped operations on SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.overlappedY()", - "smuX.trigger.initiate()" - ] - }, - { - "name": "smua.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smua.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.lock()", - "webhelpfile": "15089.htm", - "signature": "smub.cal.lock()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disables the commands that change calibration settings.", - "details": "Before you can lock calibration, the calibration constants must be written to nonvolatile memory or a previous calibration set must be restored. Error code 5012, \"Cal data not saved - save or restore before lock,\" results if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.lock()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.lock();", - "description": "Disables calibration functions for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smua.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smua.CALSET_NOMINAL nil|smua.CALSET_FACTORY nil|smua.CALSET_DEFAULT nil|smua.CALSET_PREVIOUS nil", - "type": "smuacalrestorecalset", - "range": "" - } - ], - "usage": [ - "smua.cal.restore()", - "smua.cal.restore(calset)" - ], - "overloads": [ - "smua.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.restore()", - "webhelpfile": "15090.htm", - "signature": "smub.cal.restore(calset)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads a stored set of calibration constants.", - "details": "This function overwrites the present set of calibration constants with constants read from nonvolatile\u00a0memory.This function is disabled until a successful call to smuX.cal.unlock() is made.If calset is not specified, smuX.CALSET_DEFAULT is used.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "calset", - "description": "The calibration set to be loaded; set calset to one of the following values", - "enum": "smub.CALSET_NOMINAL nil|smub.CALSET_FACTORY nil|smub.CALSET_DEFAULT nil|smub.CALSET_PREVIOUS nil", - "type": "smubcalrestorecalset", - "range": "" - } - ], - "usage": [ - "smub.cal.restore()", - "smub.cal.restore(calset)" - ], - "overloads": [ - "smub.cal.restore()" - ], - "examples": [ - { - "example": "smua.cal.restore();", - "description": "Restores factory calibration constants for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smua.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.save()", - "webhelpfile": "15091.htm", - "signature": "smub.cal.save()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active calibration constants to nonvolatile memory.", - "details": "This function stores the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) are copied to the previous calibration set (smuX.CALSET_PREVIOUS) before overwriting the default calibration set.This function is disabled until a successful call to smuX.cal.unlock() is made.If any of the calibration constants have been changed, this function is disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.cal.save()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.save();", - "description": "Stores calibration constants for SMU channel A in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smua.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smub.cal.unlock()", - "webhelpfile": "15092.htm", - "signature": "smub.cal.unlock(password)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function enables the commands that change calibration settings.", - "details": "This function enables the calibration functions to change the calibration settings.The password when the instrument is shipped from the factory is \"KI0026XX\".", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "password", - "description": "Calibration password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.unlock(password)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.unlock(\"KI0026XX\");", - "description": "Unlocks calibration for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.password", - "smuX.cal.restore()", - "smuX.cal.state" - ] - }, - { - "name": "smua.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smua.cal.adjustdate", - "smua.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.adjustdate", - "webhelpfile": "15093.htm", - "signature": "", - "command_return": "adjustDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factorycalibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the date of the last calibration adjustment.", - "details": "This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.You cannot change the adjustment date without first making a change to the calibration constants.Once you change any calibration constants, you must set the adjustment date before you can save the calibration data to the nonvolatile memory of the SMU.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00\u00a0am\u00a0Jan\u00a01,\u00a01970.Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "adjustDate", - "description": "Date of the last adjustment", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "adjustDate = smub.cal.adjustdate", - "smub.cal.adjustdate = adjustDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.adjustdate = os.time();", - "description": "Sets the adjustment date for SMU channel A to the current time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.date", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smua.cal.date", - "smua.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.date", - "webhelpfile": "15094.htm", - "signature": "", - "command_return": "calDate", - "type": "Attribute (RW)", - "default_value": "Initially set to factory calibration\u00a0date\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration date of the active calibration set.", - "details": "This attribute stores the calibration date that is associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the instrument was calibrated.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the date stored with that set.smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDate", - "description": "The calibration date of the active calibration set", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDate = smub.cal.date", - "smub.cal.date = calDate" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.date = os.time();", - "description": "Sets calibration date for SMU channel A to the present time set on the\u00a0instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.due", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smua.cal.due", - "smua.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.due", - "webhelpfile": "15095.htm", - "signature": "", - "command_return": "calDue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the calibration due date for the next calibration.", - "details": "This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function. It is typically set to the date when the next calibration should be performed.This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute reflects the due date stored with that set.smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.", - "param_info": [ - { - "name": "calDue", - "description": "Due date of next calibration (0 indicates that no date is set)", - "enum": "", - "type": "number", - "range": "(0 indicates that no date is set)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calDue = smub.cal.due", - "smub.cal.due = calDue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.due = os.time() + 365 * 24 * 60 * 60;", - "description": "Sets the SMU channel A calibration due date equal to one year from the present time set on the instrument.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "os.time()", - "smuX.cal.adjustdate", - "smuX.cal.date", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.state", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smua.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.password", - "webhelpfile": "15096.htm", - "signature": "", - "command_return": "newPassword", - "type": "Attribute (W)", - "default_value": "\"KI0026XX\"\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the password required to enable calibration.", - "details": "A new password can only be assigned when calibration has been unlocked.The calibration password is write-only and cannot be read.", - "param_info": [ - { - "name": "X", - "description": "SMU channel (for example, smua.cal.password applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.password applies to SMU channel A)" - }, - { - "name": "newPassword", - "description": "A string that contains the new password", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "smub.cal.password = newPassword" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.password = \"LetMeIn\";", - "description": "Assigns a new calibration password for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smua.CAL_AUTO nil|smua.CAL_POSITIVE nil|smua.CAL_NEGATIVE nil", - "type": "smuacalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smua.cal.polarity", - "smua.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.cal.polarity", - "webhelpfile": "15097.htm", - "signature": "", - "command_return": "calPolarity", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CAL_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls which calibration constants are used for all subsequent\u00a0measurements.", - "details": "This attribute controls which polarity calibration constants are used to make all subsequent measurements.This attribute does not affect the smuX.measure.calibrateY() command. The polarity for smuX.measure.calibrateY() is dictated by the range parameter that is defined for it. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.When making measurements for calibration points far away from zero, the desired polarity constants are inherently used. However, when making measurements near zero, it is possible that the instrument could use the calibration constants from the wrong polarity. Setting smuX.cal.polarity to positive or negative forces measurements to be made using the calibration constants for a given polarity, rather than basing the choice on the raw measurement data.This attribute can only be set to positive or negative when calibration is unlocked. This attribute is automatically set to smuX.CAL_AUTO when calibration is locked.", - "param_info": [ - { - "name": "calPolarity", - "description": "The polarity to use for measurements. Set to one of the following values", - "enum": "smub.CAL_AUTO nil|smub.CAL_POSITIVE nil|smub.CAL_NEGATIVE nil", - "type": "smubcalpolaritycalPolarity", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.cal.polarity applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.cal.polarity applies to SMU channel A)" - } - ], - "usage": [ - "calPolarity = smub.cal.polarity", - "smub.cal.polarity = calPolarity" - ], - "overloads": [], - "examples": [ - { - "example": "smua.cal.polarity = smua.CAL_POSITIVE;", - "description": "Selects positive calibration constants for all subsequent measurements on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "reset()", - "smuX.cal.lock()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()", - "smuX.reset()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smua.CALSTATE_LOCKED nil|smua.CALSTATE_CALIBRATING nil|smua.CALSTATE_UNLOCKED nil", - "type": "smuacalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smua.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smub.cal.state", - "webhelpfile": "15098.htm", - "signature": "", - "command_return": "calState", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the present calibration state.", - "details": "This read-only attribute indicates the calibration state of the instrument: Locked, calibrating, or unlocked.", - "param_info": [ - { - "name": "calState", - "description": "The present calibration state; when reading this attribute, calState has one of the following values", - "enum": "smub.CALSTATE_LOCKED nil|smub.CALSTATE_CALIBRATING nil|smub.CALSTATE_UNLOCKED nil", - "type": "smubcalstatecalState", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.cal.state applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "calState = smub.cal.state" - ], - "overloads": [], - "examples": [ - { - "example": "calstate = smua.cal.state;print(calstate);", - "description": "Reads calibration state for SMU channel A.\n--- --Output:\n--- --0.000000e+00\n--- --The above output indicates that calibration is locked.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()" - ] - }, - { - "name": "smua.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smub.contact.calibratehi()", - "webhelpfile": "15099.htm", - "signature": "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the high/sense high contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement calibration does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratelo()" - ] - }, - { - "name": "smua.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smub.contact.calibratelo()", - "webhelpfile": "15100.htm", - "signature": "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adjusts the low/sense low contact check measurement. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Contact check measurement adjustment does not require range information.Typically, points one and two are near 0\u00a0\u03a9 and 50 \u03a9, respectively.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.The new calibration constants are activated immediately but are not written to nonvolatile memory. Use smuX.cal.save() to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is disabled until a successful call to smuX.cal.unlock() is made.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "-- Short SENSE LO and LO terminals.;-- Short SENSE HI and HI terminals.;-- Allow readings to settle, then get measurements.;r0_hi, r0_lo = smua.contact.r();\u00a0;-- Connect 50 OHM resistor between SENSE LO and LO.;-- Connect 50 OHM resistor between SENSE HI and HI.;-- Allow readings to settle, then get measurements.;r50_hi, r50_lo = smua.contact.r();smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo, 50_ohm_actual_lo);smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi, 50_ohm_actual_hi);", - "description": "The instrument performs a contact check.\n--- --Install and measure two resistors.\n--- --The user sends the contact check LO calibration command.\n--- --The user sends the contact check HI calibration command.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.contact.calibratehi()" - ] - }, - { - "name": "smua.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smua.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smua.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smub.contact.check()", - "webhelpfile": "15101.htm", - "signature": "smub.contact.check()", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function determines if contact resistance is lower than the threshold. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold\u00a0attribute.An error is generated when the output is on and:An error is generated when the output is off and:", - "param_info": [ - { - "name": "result", - "description": " This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "result = smub.contact.check()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; -- take action;end;", - "description": "Takes action if contact check on SMU channel A fails.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.speed", - "smuX.contact.threshold", - "smuX.source.offfunc" - ] - }, - { - "name": "smua.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smua.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smua.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smub.contact.r()", - "webhelpfile": "15102.htm", - "signature": "smub.contact.r()", - "command_return": "rhi, rlo", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures aggregate contact resistance. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "If you attempt to perform a contact resistance measurement when any of the following conditions exist, an error is generated.", - "param_info": [ - { - "name": "rhi", - "description": "The measured aggregate contact resistance on the HI/sense HI side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "rlo", - "description": "The measured aggregate contact resistance on the LO/sense LO side", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rhi, rlo = smub.contact.r()" - ], - "overloads": [], - "examples": [ - { - "example": "if not smua.contact.check() then; smua.contact.speed = smua.CONTACT_SLOW; rhi, rlo = smua.contact.r(); print(rhi, rlo); exit();end;", - "description": "Check contacts against threshold.\n--- --Set speed for SMU channel A to slow.\n--- --Get resistance readings.\n--- --Output contact resistances to the host.\n--- --Terminate execution.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "smuX.contact.check()", - "smuX.contact.speed" - ] - }, - { - "name": "smua.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smua.CONTACT_FAST nil|smua.CONTACT_MEDIUM nil|smua.CONTACT_SLOW nil", - "type": "smuacontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smua.contact.speed", - "smua.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.speed", - "webhelpfile": "15103.htm", - "signature": "", - "command_return": "speedSetting", - "type": "Attribute (RW)", - "default_value": "0 (smuX.CONTACT_FAST)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the speed setting for contact check measurements. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).", - "param_info": [ - { - "name": "speedSetting", - "description": "The speed setting. Set to one of the following", - "enum": "smub.CONTACT_FAST nil|smub.CONTACT_MEDIUM nil|smub.CONTACT_SLOW nil", - "type": "smubcontactspeedspeedSetting", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.speed applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "speedSetting = smub.contact.speed", - "smub.contact.speed = speedSetting" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.speed = smua.CONTACT_SLOW;", - "description": "Configure contact check for higher accuracy on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.reset()" - ] - }, - { - "name": "smua.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smua.contact.threshold", - "smua.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smub.contact.threshold", - "webhelpfile": "15104.htm", - "signature": "", - "command_return": "rValue", - "type": "Attribute (RW)", - "default_value": "50 (50 \u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the resistance threshold for the smuX.contact.check() function. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set the threshold to less than 1 k\u03a9.", - "param_info": [ - { - "name": "rValue", - "description": "The resistance above which contact check fails (measured in ohms)", - "enum": "", - "type": "number", - "range": "(measured in ohms)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.contact.threshold applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "rValue = smub.contact.threshold", - "smub.contact.threshold = rValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.contact.threshold = 5;", - "description": "Set the contact check threshold for SMU channel A to 5 \u03a9.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Contact check measurements", - "reset()", - "smuX.contact.check()", - "smuX.reset()" - ] - }, - { - "name": "smua.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smua.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smua.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.makebuffer()", - "webhelpfile": "15105.htm", - "signature": "smub.makebuffer(bufferSize)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a reading buffer.", - "details": "You can use this function to create and dynamically allocate reading buffers. Use bufferSize to designate the number of readings the buffer can store.You can use dynamically allocated reading buffers interchangeably with the smuX.nvbufferY\u00a0buffers.To delete a reading buffer, set all references to the reading buffer equal to nil, then run the garbage collector (see the collectgarbage() function in Standard\u00a0libraries).", - "param_info": [ - { - "name": "bufferVar", - "description": "The created reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferSize", - "description": "Maximum number of readings that can be stored", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "bufferVar = smub.makebuffer(bufferSize)" - ], - "overloads": [], - "examples": [ - { - "example": "mybuffer2 = smua.makebuffer(200);", - "description": "Creates a 200 element reading buffer (mybuffer2) for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "collectgarbage() in Base library functions", - "Remote reading buffer programming", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smua.measure.analogfilter", - "smua.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smub.measure.analogfilter", - "webhelpfile": "15106.htm", - "signature": "", - "command_return": "option", - "type": "Attribute (RW)", - "default_value": "1 (filter on)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the use of an analog filter when measuring on the lowest current ranges (2634B, 2635B, and 2636B only).", - "details": "This attribute engages an approximately 1 Hz analog filter across the current range elements.The analog filter is only active when using the 1 nA and 100 pA measurement ranges.", - "param_info": [ - { - "name": "option", - "description": "Enables or disables the analog filter", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.analogfilter applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "option = smub.measure.analogfilter", - "smub.measure.analogfilter = option" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.analogfilter = 0;", - "description": "Turns off the SMU channel A analog filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters" - ] - }, - { - "name": "smua.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangev", - "smua.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil|smua.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smuameasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smua.measure.autorangei", - "smua.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangev", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangevautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangev", - "smub.measure.autorangev = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autorangei", - "webhelpfile": "15107.htm", - "signature": "", - "command_return": "autoRange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the measurement autorange setting.", - "details": "This attribute indicates the measurement autorange state. Its value is smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range is the present SMU measure range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit in autorange mode. It remains on its present measure range until the next measurement is requested.If source high capacitance mode is enabled, current autorange is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.", - "param_info": [ - { - "name": "autoRange", - "description": "The state of the measurement autorange setting; set to one of the following values", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil|smub.AUTORANGE_FOLLOW_LIMIT nil", - "type": "smubmeasureautorangeiautoRange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "autoRange = smub.measure.autorangei", - "smub.measure.autorangei = autoRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autorangev = smua.AUTORANGE_ON;", - "description": "Enables voltage measurement autoranging for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autoranging", - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smua.AUTOZERO_OFF nil|smua.AUTOZERO_ONCE nil|smua.AUTOZERO_AUTO nil", - "type": "smuameasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smua.measure.autozero", - "smua.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.autozero", - "webhelpfile": "15108.htm", - "signature": "", - "command_return": "azMode", - "type": "Attribute (RW)", - "default_value": "2 (smuX.AUTOZERO_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "The analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. The 2600B uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument automatically takes two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes more time than normal.This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the time that is needed for the reference measurements in these situations, you can use the smuX.measure.autozero attribute to disable the automatic reference measurements.Disabling automatic reference measurements may allow the instrument to gradually drift out of specification. To minimize the drift, make a reference and zero measurement immediately before any critical test sequences. You can use the smuX.AUTOZERO_ONCE setting to force a refresh of the reference and zero measurements that are used for the present aperture setting.", - "param_info": [ - { - "name": "azMode", - "description": "Indicates status of autozero; set to one of the following values", - "enum": "smub.AUTOZERO_OFF nil|smub.AUTOZERO_ONCE nil|smub.AUTOZERO_AUTO nil", - "type": "smubmeasureautozeroazMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.autozero applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "azMode = smub.measure.autozero", - "smub.measure.autozero = azMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.autozero = smua.AUTOZERO_ONCE;", - "description": "Performs autozero once for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Autozero", - "reset()", - "setup.recall()", - "smuX.measure.nplc", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratev()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratev(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smub.measure.calibratei()", - "webhelpfile": "15109.htm", - "signature": "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new measurement calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the instrument must be adjusted separately. Use a positive value for the range parameter to adjust the positive polarity and a negative value for the range parameter to adjust the negative polarity.All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the calibration set that is active. Corruption of the calibration constants may result if this is ignored.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Measured", - "description": "The value measured by this SMU for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Measured", - "description": "The value measured by this SMU for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.measure.calibratei(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903);", - "description": "Adjust SMU channel A voltage measurement using the following values:\n--- --1 V calibration range1e\u22124 for +zero measurement reading1e\u22125 for +zero DMM measurement reading0.92 for +FS measurement reading0.903 for the +FS DMM measurement r" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Adjustment", - "smuX.cal.lock()", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.source.calibrateY()" - ] - }, - { - "name": "smua.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuameasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smua.measure.delay", - "smua.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delay", - "webhelpfile": "15111.htm", - "signature": "", - "command_return": "mDelay", - "type": "Attribute (RW)", - "default_value": "2601B, 2602B, 2604B, 2611B, 2612B, 2614B:0 (smuX.DELAY_OFF)\n2634B, 2635B, 2636B:\u22121 (smuX.DELAY_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls the measurement delay.", - "details": "This attribute allows for additional delay (settling time) before making a measurement. If you define the value instead of using the automatic delay value, the delay you set is used regardless of the range.The smuX.DELAY_AUTO setting causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.", - "param_info": [ - { - "name": "mDelay", - "description": "Set to the measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)You can also set it to one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubmeasuredelaymDelay", - "range": "(for example, to specify an additional 10 ms measurement delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "mDelay = smub.measure.delay", - "smub.measure.delay = mDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delay = 0.010;", - "description": "Sets a 10 ms measurement delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.count", - "smuX.measure.delayfactor", - "smuX.source.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smua.measure.delayfactor", - "smua.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.delayfactor", - "webhelpfile": "15112.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.", - "details": "The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor multiplier", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "delayFactor = smub.measure.delayfactor", - "smub.measure.delayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.delayfactor = 2.0;", - "description": "Doubles the measure delay for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measure autodelay", - "reset()", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smua.measure.filter.count", - "smua.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.count", - "webhelpfile": "15113.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the number of measured readings that are required to yield one filtered measurement.", - "details": "This attribute sets the size of the stack used for filtered measurements.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "filterCount = smub.measure.filter.count", - "smub.measure.filter.count = filterCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.enable", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smua.FILTER_OFF nil|smua.FILTER_ON nil", - "type": "smuameasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smua.measure.filter.enable", - "smua.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.enable", - "webhelpfile": "15114.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILTER_OFF)\n", - "tsp_link": "Yes\n", - "description": "This command enables or disables filtered measurements.", - "details": "This command enables or disables the filter.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status; set to one of the following values", - "enum": "smub.FILTER_OFF nil|smub.FILTER_ON nil", - "type": "smubmeasurefilterenablefilterState", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.enable applies to SMU channel A)" - } - ], - "usage": [ - "filterState = smub.measure.filter.enable", - "smub.measure.filter.enable = filterState" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.type", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smua.FILTER_MOVING_AVG nil|smua.FILTER_REPEAT_AVG nil|smua.FILTER_MEDIAN nil", - "type": "smuameasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smua.measure.filter.type", - "smua.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.filter.type", - "webhelpfile": "15115.htm", - "signature": "", - "command_return": "filterType", - "type": "Attribute (RW)", - "default_value": "1 (smuX.FILTER_REPEAT_AVG)\n", - "tsp_link": "Yes\n", - "description": "This command sets the type of filter used for measurements when the measurement filter is enabled.", - "details": "The 2600B provides a moving average, repeating average, and median filter type.For the repeating filter, the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the reading nearest to the middle is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.", - "param_info": [ - { - "name": "filterType", - "description": "The filter type to use when filtering is enabled. Set to one of the following values", - "enum": "smub.FILTER_MOVING_AVG nil|smub.FILTER_REPEAT_AVG nil|smub.FILTER_MEDIAN nil", - "type": "smubmeasurefiltertypefilterType", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.filter.type applies to SMU Channel A)" - } - ], - "usage": [ - "filterType = smub.measure.filter.type", - "smub.measure.filter.type = filterType" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.filter.count = 10;smua.measure.filter.type = smua.FILTER_MOVING_AVG;smua.measure.filter.enable = smua.FILTER_ON;", - "description": "Sets the filter count for SMU channel A to 10.\n--- --Sets the filter type to moving average.\n--- --Enables the filter.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Filters", - "reset()", - "setup.recall()", - "smuX.measure.filter.count", - "smuX.measure.filter.enable", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smua.measure.highcrangedelayfactor", - "smua.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smub.measure.highcrangedelayfactor", - "webhelpfile": "15116.htm", - "signature": "", - "command_return": "delayFactor", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is\u00a0active.", - "details": "This delay multiplier is only active when the high-capacitance mode is active.", - "param_info": [ - { - "name": "delayFactor", - "description": "The delay factor; set to a value between 1 and 99", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)" - } - ], - "usage": [ - "delayFactor = smub.measure.highcrangedelayfactor", - "smub.measure.highcrangedelayfactor = delayFactor" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.highcrangedelayfactor = 5;", - "description": "Increases the delay used during range changes for SMU channel A by a factor of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode", - "reset()", - "setup.recall()", - "smuX.reset()", - "smuX.source.highc" - ] - }, - { - "name": "smua.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smua.measure.interval", - "smua.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.interval", - "webhelpfile": "15117.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "0 (0 s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the interval between multiple measurements.", - "details": "This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU attempts to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements are made as quickly as possible.If filtered measurements are being made, the time interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.", - "param_info": [ - { - "name": "interval", - "description": "The interval value (in seconds); set to a value between 0 and 1", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.measure.interval applies to SMU Channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.measure.interval applies to SMU Channel A)" - } - ], - "usage": [ - "interval = smub.measure.interval", - "smub.measure.interval = interval" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.interval = 0.5;", - "description": "Sets the measure interval for SMU channel A to 0.5\u00a0s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.count", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangev", - "smua.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smua.measure.lowrangei", - "smua.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangev", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangev", - "smub.measure.lowrangev = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.lowrangei", - "webhelpfile": "15118.htm", - "signature": "", - "command_return": "lowRange", - "type": "Attribute (RW)", - "default_value": "Current: 2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100 nA)\n2634B:1e-9 (1 nA)\n2635B, 2636:100e-12 (100 pA)\nVoltage:2601B, 2602B, 2604B:100e-3 (100 mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:200e-3 (200 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest measurement range that is used when the instrument is autoranging.", - "details": "This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.If the instrument is set to autorange and it is on a range lower than the one specified, the range is changed to the lowRange range value.", - "param_info": [ - { - "name": "lowRange", - "description": "The lowest voltage or current measurement range used during autoranging", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measure function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "lowRange = smub.measure.lowrangei", - "smub.measure.lowrangei = lowRange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.lowrangev = 1;", - "description": "Sets voltage low range for SMU channel A to 1\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smua.measure.nplc", - "smua.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smub.measure.nplc", - "webhelpfile": "15119.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1.0\n", - "tsp_link": "Yes\n", - "description": "This command sets the integration aperture for measurements.", - "details": "This attribute controls the integration aperture for the analog\u2011to\u2011digital converter (ADC).The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67\u00a0ms (1/60) and 1\u00a0PLC for 50 Hz is 20 ms (1/50).", - "param_info": [ - { - "name": "nplc", - "description": "The integration aperture; set from 0.001 to 25", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "nplc = smub.measure.nplc", - "smub.measure.nplc = nplc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.nplc = 0.5;", - "description": "Sets the integration time for SMU channel A to 0.5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.reset()", - "Speed" - ] - }, - { - "name": "smua.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smua.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedv(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedv(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedi()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedi(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedi(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedr()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedr(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedr(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappedp()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappedp(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappedp(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smub.measure.overlappediv()", - "webhelpfile": "15120.htm", - "signature": "smub.measure.overlappediv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function starts an asynchronous (background) measurement.", - "details": "This function starts a measurement and returns immediately. The measurements, as they are performed, are stored in a reading buffer (along with any other information that is being acquired). If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The second form of this function, smuX.measure.overlappediv(), stores current readings in ibuffer and voltage readings in vbuffer.This function is an overlapped command. Script execution continues while the measurements are made in the background. Attempts to access result values that have not yet been generated cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before\u00a0continuing.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append data.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.measure.overlappediv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Starts background voltage measurements for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "waitcomplete()" - ] - }, - { - "name": "smua.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangev", - "smua.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.measure.rangei", - "smua.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangev", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangev", - "smub.measure.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.measure.rangei", - "webhelpfile": "15121.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:2601B, 2602B, or 2604B: 100e-3 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, or 2636B:200e-3 (200\u00a0mV)\nCurrent:100e-3 (100 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the positive full\u2011scale value of the measurement range for voltage or current.", - "details": "Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument selects the best range for measuring a value of rangeValue.This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, measuring 10.0 V on the 2601B, 2602B, or 2604B 6 V range or measuring 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange. The value 9.91000E+37 is returned when this occurs. If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range is used.2601B, 2602B, or 2604B example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 6 V. Since the source range is 1 V, the SMU performs voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements are made on the 6 V range.Explicitly setting a measure range disables measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.Changing the range while the output is off does not update the hardware settings, but querying returns the range setting that is used when the output is turned on. Setting a range while the output is on takes effect immediately.With measure autoranging enabled, the range is changed only when a measurement is made. Querying the range after a measurement returns the range selected for that measurement.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.measure.rangei", - "smub.measure.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rangev = 0.5 ;", - "description": "Selects the 1\u00a0V measurement range for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.autorangeY", - "smuX.reset()", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.v()", - "reading = smua.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.i()", - "reading = smua.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.r()", - "reading = smua.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smua.measure.p()", - "reading = smua.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smua.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smua.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)", - "iReading, vReading = smua.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smua.measure.iv()", - "iReading, vReading = smua.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.v()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.v(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.v()", - "reading = smub.measure.v(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.v()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.i()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.i(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.i()", - "reading = smub.measure.i(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.i()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.r()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.r(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.r()", - "reading = smub.measure.r(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.r()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.p()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.p(readingBuffer)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "reading = smub.measure.p()", - "reading = smub.measure.p(readingBuffer)" - ], - "overloads": [ - "reading = smub.measure.p()" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.measure.iv()", - "webhelpfile": "15122.htm", - "signature": "smub.measure.iv(iReadingBuffer, vReadingBuffer)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or more measurements.", - "details": "If you use this function without specifying a reading buffer, it makes one measurement and returns that measurement as reading. To use the additional information that is acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings are available in readingBuffer, but only the last measurement is returned as reading.Measurements are in the following units of measure:The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU ignores the smuX.measure.count attribute and only makes one measurement.The readingBuffer is cleared before making any measurements unless the buffer is configured to append data.", - "param_info": [ - { - "name": "reading", - "description": "Returned value of the last (or only) reading of the measurement process", - "enum": "", - "type": "number", - "range": "(or only)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "readingBuffer", - "description": "A reading buffer object where all readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "iReading", - "description": "The last reading of the current measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The last reading of the voltage measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReadingBuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vReadingBuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)", - "iReading, vReading = smub.measure.iv(iReadingBuffer, vReadingBuffer)" - ], - "overloads": [ - "iReading, vReading = smub.measure.iv()", - "iReading, vReading = smub.measure.iv(iReadingBuffer)" - ], - "examples": [ - { - "example": "smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);", - "description": "Makes 10 voltage measurements using SMU channel A and stores them in a buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.count", - "smuX.measure.overlappedY()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablev", - "smua.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablei", - "smua.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enabler", - "smua.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smua.REL_OFF nil|smua.REL_ON nil", - "type": "smuameasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smua.measure.rel.enablep", - "smua.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablev", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablevrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablev", - "smub.measure.rel.enablev = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablei", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableirelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablei", - "smub.measure.rel.enablei = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enabler", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenablerrelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enabler", - "smub.measure.rel.enabler = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.enablep", - "webhelpfile": "15123.htm", - "signature": "", - "command_return": "relEnable", - "type": "Attribute (RW)", - "default_value": "0 (smuX.REL_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns relative measurements on or off. ", - "details": "This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value specified by smuX.measure.rel.levelY. Each returned measured relative reading is the result of the following\u00a0calculation:Relative reading = Actual measured reading \u2212 Relative offset value", - "param_info": [ - { - "name": "relEnable", - "description": "Relative measurement control. Set relEnable to one of the following values", - "enum": "smub.REL_OFF nil|smub.REL_ON nil", - "type": "smubmeasurerelenableprelEnable", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relEnable = smub.measure.rel.enablep", - "smub.measure.rel.enablep = relEnable" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.enablev = smua.REL_ON;", - "description": "Enables relative voltage measurements for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "setup.recall()", - "smuX.measure.rel.levelY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelv", - "smua.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.leveli", - "smua.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelr", - "smua.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smua.measure.rel.levelp", - "smua.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelv", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelv", - "smub.measure.rel.levelv = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.leveli", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.leveli", - "smub.measure.rel.leveli = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelr", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelr", - "smub.measure.rel.levelr = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.rel.levelp", - "webhelpfile": "15124.htm", - "signature": "", - "command_return": "relValue", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the offset value for relative measurements.", - "details": "This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings are offset by the value of this attribute. Each returned measured relative reading is the result of the following calculation: Relative reading = Actual measured reading - Relative offset value", - "param_info": [ - { - "name": "relValue", - "description": "Relative measurement offset value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - } - ], - "usage": [ - "relValue = smub.measure.rel.levelp", - "smub.measure.rel.levelp = relValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.rel.levelv = smua.measure.v();", - "description": "Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Relative offset", - "reset()", - "smuX.measure.rel.enableY", - "smuX.reset()" - ] - }, - { - "name": "smua.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smua.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smua.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smua.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurevandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurevandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurevandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureiandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureiandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measureiandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurerandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurerandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurerandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measurepandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measurepandstep(sourceValue)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = smub.measurepandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.measureivandstep()", - "webhelpfile": "15125.htm", - "signature": "smub.measureivandstep(sourceValue)", - "command_return": "iReading, vReading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes one or two measurements and then steps the source.", - "details": "The smuX.measureYandstep() function makes a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but makes two measurements simultaneously, one for current (i) and one for voltage (v).Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.Make sure the specified source value is appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.Both source and measure autorange must be disabled before using this function. This function cannot be used if source high capacitance mode is enabled (high capacitance mode requires autoranging to be enabled).This function is provided for very fast execution of source-measure loops. The measurement is made before the source is stepped. Before using this function, and before any loop this function may be used in, set the source value to its initial level.", - "param_info": [ - { - "name": "reading", - "description": "The measured reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement function (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "sourceValue", - "description": "Source value to be set after the measurement is made", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "iReading", - "description": "The current reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "vReading", - "description": "The voltage reading before stepping the source", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "iReading, vReading = smub.measureivandstep(sourceValue)" - ], - "overloads": [], - "examples": [ - { - "example": "local ivalues = {};smua.source.rangev = 1;smua.source.levelv = 0;smua.measure.rangei = 0.01;smua.source.output = smua.OUTPUT_ON;for index = 1, 10 do; ivalues[index] = smua.measureiandstep(index / 10);end;ivalues[11] = smua.measure.i();", - "description": "This use of the SMU channel A measure and step function measures current starting at a source value of 0\u00a0V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. \n--- --\u00a0\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.measure.Y()", - "smuX.source.autorangeY", - "smuX.trigger.source.limitY", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smua.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer1", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer1" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smub.nvbuffer2", - "webhelpfile": "15126.htm", - "signature": "", - "command_return": "bufferVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains a dedicated reading buffer.", - "details": "Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.", - "param_info": [ - { - "name": "bufferVar", - "description": "The dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU nonvolatile buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "bufferVar = smub.nvbuffer2" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.overlappedv(smua.nvbuffer1);", - "description": "Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "Reading buffers", - "savebuffer()", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.savebuffer()", - "smuX.trigger.measure.action", - "smuX.trigger.measure.set()", - "smuX.trigger.measure.stimulus", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.appendmode", - "webhelpfile": "15127.htm", - "signature": "bufferVar.appendmode", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the state of the append mode of the reading buffer.", - "details": "Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.", - "param_info": [ - { - "name": "state", - "description": "The reading buffer append mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.appendmode", - "bufferVar.appendmode = state" - ], - "overloads": [], - "examples": [ - { - "example": "buffer1.appendmode = 1;", - "description": "Append new readings to contents of the reading buffer named buffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers" - ] - }, - { - "name": "bufferVar.basetimestamp", - "webhelpfile": "15128.htm", - "signature": "bufferVar.basetimestamp", - "command_return": "basetime", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp that indicates when the first reading was stored in the buffer.", - "details": "This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 am January 1, 1970 (UTC) that the measurement was performed and stored.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.", - "param_info": [ - { - "name": "basetime", - "description": "The timestamp of the first stored reading", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "basetime = bufferVar.basetimestamp" - ], - "overloads": [], - "examples": [ - { - "example": "basetime = smua.nvbuffer1.basetimestamp;print(basetime);", - "description": "Read the timestamp for the first reading stored in dedicated reading buffer 1.\n--- --Output:\n--- --1.57020e+09\n--- --This output indicates that the timestamp is 1,570,200,000 seconds (which is Friday, October 4, 2019 at 14:40:00 pm).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "15129.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This read-only attribute reads the number of readings that can be stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.The capacity of the buffer does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is\u00a0created.See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity" - ], - "overloads": [], - "examples": [ - { - "example": "bufferCapacity = smua.nvbuffer1.capacity;\u00a0;print(bufferCapacity);", - "description": "Reads the capacity of dedicated readingbuffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n--- --Output:\n--- --1.49789e+05\n--- --The above output indicates that the buffer can hold 149789 readings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.makebuffer()", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "15130.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function empties the buffer.", - "details": "This function clears all readings and related recall attributes from the buffer (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clear();", - "description": "Clears dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.clearcache()", - "webhelpfile": "15131.htm", - "signature": "bufferVar.clearcache()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the cache.", - "details": "This function clears all readings from the specified cache. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when you:To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.", - "param_info": [ - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferVar.clearcache()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.clearcache();", - "description": "Clears the reading buffer cache for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "Reading buffers", - "Removing stale values from the reading buffer cache", - "smuX.nvbufferY" - ] - }, - { - "name": "bufferVar.collectsourcevalues", - "webhelpfile": "15132.htm", - "signature": "bufferVar.collectsourcevalues", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not source values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, source values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer, but does not change the capacity of a user-defined dynamically allocated buffer.You cannot collect source values when smuX.trigger.measure.action is set to smuX.ASYNC, so bufferVar.collectsourcevalues must be set to 0 when the measurement action is set to be asynchronous.", - "param_info": [ - { - "name": "state", - "description": "Source value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "state = bufferVar.collectsourcevalues", - "bufferVar.collectsourcevalues = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collectsourcevalues = 1;", - "description": "Include source values with readings for dedicated reading buffer\u00a01.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.collecttimestamps", - "webhelpfile": "15133.htm", - "signature": "bufferVar.collecttimestamps", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets whether or not timestamp values are stored with the readings in the buffer.", - "details": "Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.When on, timestamp values are stored with readings in the buffer. This requires four extra bytes of storage for each reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.The state variable can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.", - "param_info": [ - { - "name": "state", - "description": "Timestamp value collection status; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = bufferVar.collecttimestamps", - "bufferVar.collecttimestamps = state" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.collecttimestamps = 1;", - "description": "Include timestamps with readings for dedicated reading buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "15134.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the buffer.", - "details": "This read-only attribute contains the number of readings presently stored in the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "numberOfReadings = smua.nvbuffer1.n;print(numberOfReadings);", - "description": "Reads the number of readings stored in dedicated reading buffer 1 (source\u2011measure unit (SMU) channel A).\n--- --Output:\n--- --1.25000+02\n--- --The above output indicates that there are 125 readings stored in the buffer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "bufferVar.timestampresolution", - "webhelpfile": "15135.htm", - "signature": "bufferVar.timestampresolution", - "command_return": "resolution", - "type": "Attribute (RW)", - "default_value": "1e-6 (1 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the resolution of the timestamp.", - "details": "Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.The finest timestamp resolution is 0.000001 seconds (1 \u03bcs). At this resolution, the reading buffer can store unique timestamps for up to 71\u00a0minutes. You can increase this value for very long tests.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "resolution", - "description": "Timestamp resolution in seconds (minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)", - "enum": "", - "type": "number", - "range": "(minimum 1\u00a0\u00b5s; rounded to an even power of\u00a02\u00a0\u00b5s)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "resolution = bufferVar.timestampresolution" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.timestampresolution = 0.000008;\u00a0;", - "description": "Sets the timestamp resolution of dedicated reading buffer 1 to 8 \u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.timestamps", - "Reading buffers", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.Y()" - ] - }, - { - "name": "smua.reset()", - "webhelpfile": "15136.htm", - "signature": "smua.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smub.reset()", - "webhelpfile": "15136.htm", - "signature": "smub.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function turns off the output and resets the commands that begin with smuX. to their default settings.", - "details": "This function turns off the output and returns the specified SMU to its default settings.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.reset();", - "description": "Turns off the output and resets SMU channel\u00a0A to its default\u00a0settings.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()" - ] - }, - { - "name": "smua.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smua.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smua.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smub.savebuffer()", - "webhelpfile": "15137.htm", - "signature": "smub.savebuffer(buffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves one source\u2011measure unit (SMU) dedicated reading buffer to nonvolatile memory (there are two dedicated reading buffers for each SMU).", - "details": "When the instrument is turned off and back on, the dedicated reading buffers are restored from nonvolatile memory to their last saved values.", - "param_info": [ - { - "name": "buffer", - "description": "Buffer variable", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.savebuffer(smua.nvbuffer1)" - }, - { - "name": "Y", - "description": "SMU dedicated reading buffer (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "smub.savebuffer(buffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.savebuffer(smua.nvbuffer1);\u00a0;", - "description": "Saves buffer 1 (SMU channel A) to internal\u00a0memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "savebuffer()", - "smuX.nvbufferY" - ] - }, - { - "name": "smua.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smua.SENSE_LOCAL nil|smua.SENSE_REMOTE nil|smua.SENSE_CALA nil", - "type": "smuasensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smua.sense", - "smua.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smub.sense", - "webhelpfile": "15138.htm", - "signature": "", - "command_return": "senseMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SENSE_LOCAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the sense mode.", - "details": "Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.The sense mode can be changed between local and remote while the output is on.The calibration sense mode cannot be selected while the output is on.Resetting the instrument selects the local sense mode.", - "param_info": [ - { - "name": "senseMode", - "description": "The sense mode; set to one of the following", - "enum": "smub.SENSE_LOCAL nil|smub.SENSE_REMOTE nil|smub.SENSE_CALA nil", - "type": "smubsensesenseMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "senseMode = smub.sense", - "smub.sense = senseMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.sense = smua.SENSE_REMOTE;", - "description": "Selects remote sensing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Series 2600B User's Guide:", - "2-wire local sensing connections", - "4-wire remote sensing connections", - "Sense mode selection" - ] - }, - { - "name": "smua.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangev", - "smua.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smua.AUTORANGE_OFF nil|smua.AUTORANGE_ON nil", - "type": "smuasourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smua.source.autorangei", - "smua.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangev", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangevsourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangev", - "smub.source.autorangev = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smub.source.autorangei", - "webhelpfile": "15139.htm", - "signature": "", - "command_return": "sourceAutorange", - "type": "Attribute (RW)", - "default_value": "1 (smuX.AUTORANGE_ON)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of the source autorange control (on/off). ", - "details": "This attribute indicates the source autorange state. Its value is smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used is the present SMU source circuit range.Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU immediately changes range to the range most appropriate for the value being sourced if that range is different than the present SMU range.Autorange is disabled if the source level is edited from the front panel. Setting the source range also turns off autorange when set by using the smuX.source.rangeY\u00a0attribute.Resetting the instrument selects the smuX.AUTORANGE_ON.", - "param_info": [ - { - "name": "sourceAutorange", - "description": "The state of the source autorange control. Set to one of the following", - "enum": "smub.AUTORANGE_OFF nil|smub.AUTORANGE_ON nil", - "type": "smubsourceautorangeisourceAutorange", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceAutorange = smub.source.autorangei", - "smub.source.autorangei = sourceAutorange" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.autorangev = smua.AUTORANGE_ON;", - "description": "Enables volts source autorange for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.measure.autorangeY", - "smuX.source.rangeY" - ] - }, - { - "name": "smua.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smua.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smub.source.compliance", - "webhelpfile": "15141.htm", - "signature": "", - "command_return": "compliance", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the state of source compliance. ", - "details": "Reading this attribute updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers but is similar to the Current Limit (ILMT).", - "param_info": [ - { - "name": "compliance", - "description": "The state of source compliance", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "compliance = smub.source.compliance" - ], - "overloads": [], - "examples": [ - { - "example": "compliance = smua.source.compliance;\u00a0;print(compliance);", - "description": "Reads the source compliance state for SMU channel A.\n--- --Output:\n--- --true\n--- --This output indicates that a configured limit has been reached (voltage, current, or power limit).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.limitY" - ] - }, - { - "name": "smua.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smua.DELAY_OFF nil|smua.DELAY_AUTO nil", - "type": "smuasourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smua.source.delay", - "smua.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smub.source.delay", - "webhelpfile": "15142.htm", - "signature": "", - "command_return": "sDelay", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DELAY_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source delay.", - "details": "This attribute allows for additional delay (settling time) after an output step.The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values as defined in the 2600B specifications.", - "param_info": [ - { - "name": "sDelay", - "description": "Set to the source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010); you can also set it one of the following values", - "enum": "smub.DELAY_OFF nil|smub.DELAY_AUTO nil", - "type": "smubsourcedelaysDelay", - "range": "(for example, to specify an additional 10 ms source delay, set the value to 0.010)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sDelay = smub.source.delay", - "smub.source.delay = sDelay" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.delay = smua.DELAY_AUTO;", - "description": "Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted whenever the source is changed).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.measure.count", - "smuX.measure.delay", - "smuX.reset()" - ] - }, - { - "name": "smua.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratev()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratev(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smub.source.calibratei()", - "webhelpfile": "15143.htm", - "signature": "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates and activates new source calibration constants.", - "details": "This function generates and activates new calibration constants for the given range.The positive and negative polarities of the source must be adjusted separately. Use a positive value for range to adjust the positive polarity and a negative value for range to adjust the negative polarity. Do not use 0.0 for a negative point; 0.0 is considered to be a positive number.Typically, the two points that are used are near zero for point 1 and 90% of full scale for point\u00a02. Full scale for point\u00a02 should be avoided if the source of the SMU is substantially out of calibration.The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this\u00a0command.The new calibration constants are activated immediately but they are not written to nonvolatile memory. Use the smuX.cal.save() function to save the new constants to nonvolatile memory. The active calibration constants stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile memory with the smuX.cal.restore() function.This function is only available when calibration is unlocked using smuX.cal.unlock().", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "range", - "description": "The measurement range to adjust", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Expected", - "description": "The source value set for point 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp1Reference", - "description": "The reference measurement for point 1 as measured externally", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Expected", - "description": "The source value set for point 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "cp2Reference", - "description": "The reference measurement for point 2 as measured externally", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.source.calibratei(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903);", - "description": "Generates and activates new source calibration constants for the 1\u00a0A range. For point 1, it uses 1e\u221210 as the source value and 1e\u22125 as the reference measurement. For point 2, it uses 0.9 for the source value and 0.903 for the reference measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Calibration", - "smuX.cal.restore()", - "smuX.cal.save()", - "smuX.cal.unlock()", - "smuX.measure.calibrateY()" - ] - }, - { - "name": "smua.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smua.source.func", - "smua.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.func", - "webhelpfile": "15144.htm", - "signature": "", - "command_return": "sFunction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function, which can be voltage or current.", - "details": "Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the SMU channel as either a voltage source or a current\u00a0source.", - "param_info": [ - { - "name": "sFunction", - "description": "The source function; set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourcefuncsFunction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sFunction = smub.source.func", - "smub.source.func = sFunction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.func = smua.OUTPUT_DCAMPS;", - "description": "Sets the source function of SMU channel A to be a current\u00a0source.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.levelY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smua.source.highc", - "smua.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smub.source.highc", - "webhelpfile": "15145.htm", - "signature": "", - "command_return": "highC", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high-capacitance mode.", - "details": "When enabled, the high-capacitance mode has the following effects on the SMU settings:", - "param_info": [ - { - "name": "highC", - "description": "The state of the high-capacitance mode; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcehighchighC", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "highC = smub.source.highc", - "smub.source.highc = highC" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.highc = smua.ENABLE;", - "description": "Activates high-capacitance mode for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "High-capacitance mode" - ] - }, - { - "name": "smua.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.levelv", - "smua.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smua.source.leveli", - "smua.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.levelv", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.levelv", - "smub.source.levelv = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smub.source.leveli", - "webhelpfile": "15146.htm", - "signature": "", - "command_return": "sourceLevel", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source level.", - "details": "This attribute configures the output level of the voltage or current source.If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting is sourced immediately. If the output is off or the source is configured as a current source, the voltage level is sourced when the source is configured as a voltage source and the output is turned\u00a0on.If the source is configured as a current source and the output is on, the new smuX.source.leveli setting is sourced immediately. If the output is off or the source is configured as a voltage source, the current level is sourced when the source is configured as a current source and the output is turned\u00a0on.The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.The reset() function sets the source levels to 0\u00a0V and 0 A.", - "param_info": [ - { - "name": "sourceLevel", - "description": "The source value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLevel = smub.source.leveli", - "smub.source.leveli = sourceLevel" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.levelv = 1;", - "description": "Sets voltage source of SMU channel A to 1 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output", - "Source-measure concepts" - ] - }, - { - "name": "smua.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangev", - "smua.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smua.source.lowrangei", - "smua.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangev", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangev", - "smub.source.lowrangev = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.lowrangei", - "webhelpfile": "15148.htm", - "signature": "", - "command_return": "sourceRangeLow", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B: 100e\u20113 (100\u00a0mV)2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e\u20113 (200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B: 100e\u20119 (100\u00a0nA)2634B, 2635B, 2636B: 1e\u20119 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the lowest source range that is used during autoranging.", - "details": "This attribute is used with source autoranging to put a lower bound on the range that is used. Lower ranges generally require greater settling times. If you set a low range value, you might be able to source small values with less settling time.If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range is changed to the range specified by sourceRangeLow.", - "param_info": [ - { - "name": "sourceRangeLow", - "description": "Set to the lowest voltage (in volts) or current (in amperes) range to be used", - "enum": "", - "type": "number", - "range": "(in volts)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceRangeLow = smub.source.lowrangei", - "smub.source.lowrangei = sourceRangeLow" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.lowrangev = 1;", - "description": "Sets volts low range for Models 2601B, 2602B, 2604B SMU A to 1\u00a0V. This prevents the source from using the 100 mV range when sourcing voltage.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimitv", - "smua.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smua.source.offlimiti", - "smua.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimitv", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimitv", - "smub.source.offlimitv = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.offlimiti", - "webhelpfile": "15149.htm", - "signature": "", - "command_return": "sourceLimit", - "type": "Attribute (RW)", - "default_value": "Current: 1e-3 (1\u00a0mA)Voltage: 40\u00a0(40\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the limit (current or voltage) used when the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "Setting the current limit to lower than 1\u00a0mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.", - "param_info": [ - { - "name": "sourceLimit", - "description": "Set to the limit to be used when the SMU is in normal output-off mode", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offlimiti applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sourceLimit = smub.source.offlimiti", - "smub.source.offlimiti = sourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offlimiti = 10e-3;", - "description": "Changes the normal output-off mode limit to 10\u00a0mA for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.contact.check()", - "smuX.contact.r()", - "smuX.source.offfunc", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smua.OUTPUT_NORMAL nil|smua.OUTPUT_ZERO nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smua.source.offmode", - "smua.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offmode", - "webhelpfile": "15150.htm", - "signature": "", - "command_return": "sourceOffMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_NORMAL)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source output-off mode.", - "details": "Reading this attribute returns the output-off mode of the source. Setting this attribute configures the SMU output-off mode.The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function is configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0\u00a0V voltage source or a 0\u00a0A current source. When the SMU is operating as a 0\u00a0A current source, the smuX.source.offlimitv attribute sets the voltage limit (similar to how the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0\u00a0V voltage source).When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source is configured to output 0\u00a0V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit is not changed. If the source function is current, the current limit is set to the current source level or 10 percent of the current source range, whichever is greater.When sourceOffMode is set to smuX.OUTPUT_HIGH_Z, the SMU opens the output relay when the output is turned off.", - "param_info": [ - { - "name": "sourceOffMode", - "description": "The output-off setting; set to one of the following values", - "enum": "smub.OUTPUT_NORMAL nil|smub.OUTPUT_ZERO nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoffmodesourceOffMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOffMode = smub.source.offmode", - "smub.source.offmode = sourceOffMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_HIGH_Z;", - "description": "Sets the output\u2011off mode for SMU channel A to open the output relay when the output is turned off.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offfunc", - "smuX.source.offlimitY", - "smuX.source.output" - ] - }, - { - "name": "smua.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smua.OUTPUT_OFF nil|smua.OUTPUT_ON nil|smua.OUTPUT_HIGH_Z nil", - "type": "smuasourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smua.source.output", - "smua.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smub.source.output", - "webhelpfile": "15151.htm", - "signature": "", - "command_return": "sourceOutput", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OUTPUT_OFF)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the source output.", - "details": "Reading this attribute returns the output state of the source. Setting this attribute switches the output of the source on or off.When the output is switched on, the SMU sources either voltage or current, as set by smuX.source.func.Setting this attribute to smuX.OUTPUT_HIGH_Z causes the output to turn off and go to the High Z mode. If the smuX.source.output is read after setting this attribute to smuX.OUTPUT_HIGH_Z, it returns\u00a00.", - "param_info": [ - { - "name": "sourceOutput", - "description": "The output state setting of the source; set to one of the following values", - "enum": "smub.OUTPUT_OFF nil|smub.OUTPUT_ON nil|smub.OUTPUT_HIGH_Z nil", - "type": "smubsourceoutputsourceOutput", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sourceOutput = smub.source.output", - "smub.source.output = sourceOutput" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.output = smua.OUTPUT_ON;", - "description": "Turns on the SMU channel A source output.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.func", - "smuX.source.offmode" - ] - }, - { - "name": "smua.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smua.OE_NONE nil|smua.OE_OUTPUT_OFF nil", - "type": "smuasourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smua.source.outputenableaction", - "smua.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.outputenableaction", - "webhelpfile": "15152.htm", - "signature": "", - "command_return": "outputAction", - "type": "Attribute (RW)", - "default_value": "0 (smuX.OE_NONE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls output enable action of the source.", - "details": "For 2601B, 2602B, or 2604B, this attribute controls the action the SMU takes when the output enable line is deasserted.When set to smuX.OE_NONE, the SMU takes no action when the output enable line goes low (deasserted).When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU turns its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.The SMU does not automatically turn its output on when the output enable line returns to the high state.If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output turns off immediately.Detection of the output enable line going low does not abort any running scripts. This may cause execution errors.For models that have a safety interlock (2611B, 2612B, 2614B, 2635B, 2636B, and 2634B), this attribute dictates the source output behavior when the interlock line is not engaged and the source is configured for safe operation. In the following situations, source output automatically turns off when the interlock is disengaged and the output cannot be turned on unless the interlock is engaged:In the following situations, the source ignores the state of the interlock signal and the output can be turned on regardless of the interlock state:In the following situations, the source output automatically turns off when the interlock is disengaged, the output cannot be turned on unless the interlock is engaged, and the smuX.source.outputenableaction attribute is ignored:", - "param_info": [ - { - "name": "outputAction", - "description": "The output enable action of the source; set to one of the following values", - "enum": "smub.OE_NONE nil|smub.OE_OUTPUT_OFF nil", - "type": "smubsourceoutputenableactionoutputAction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "outputAction = smub.source.outputenableaction", - "smub.source.outputenableaction = outputAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.outputenableaction = smua.OE_OUTPUT_OFF;", - "description": "Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smua.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangev", - "smua.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smua.source.rangei", - "smua.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangev", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangev", - "smub.source.rangev = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smub.source.rangei", - "webhelpfile": "15153.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "Voltage:\n2601B, 2602B, 2604B:100e-3 (100\u00a0mV)\n2611B, 2612B, 2614B, 2634B, 2635B, 2636B: 200e-3\u00a0(200\u00a0mV)\nCurrent:\n2601B, 2602B, 2604B, 2611B, 2612B, 2614B:100e-9 (100\u00a0nA)2634B, 2635B, 2636B:1e-9 (1\u00a0nA)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range.", - "details": "This attribute contains a value that sets the source\u2011measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument selects the best range for sourcing a value of rangeValue.Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set returns the range the instrument chose as appropriate for that source level.This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. For example, sourcing 10.0\u00a0V on the Model 2601B, 2602B, or 2604B 6 V range or sourcing 5.0 V on the 2611B, 2612B, or 2614B 2 V range causes an overrange condition.", - "param_info": [ - { - "name": "rangeValue", - "description": "Set to the maximum expected voltage or current to be sourced", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "rangeValue = smub.source.rangei", - "smub.source.rangei = rangeValue" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.rangev = 1;", - "description": "Selects the 1 V source range for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range", - "reset()", - "setup.recall()", - "smuX.measure.rangeY", - "smuX.reset()", - "smuX.source.autorangeY" - ] - }, - { - "name": "smua.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smua.SETTLE_SMOOTH nil|smua.SETTLE_FAST_RANGE nil|smua.SETTLE_FAST_POLARITY nil|smua.SETTLE_DIRECT_IRANGE nil|smua.SETTLE_SMOOTH_100NA nil|smua.SETTLE_FAST_ALL nil|smua.SETTLE_FAST_ nil", - "type": "smuasourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smua.source.settling", - "smua.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smub.source.settling", - "webhelpfile": "15154.htm", - "signature": "", - "command_return": "settleOption", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SETTLE_SMOOTH)\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source settling mode.", - "details": "Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default \u201crange-by-range\u201d method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.smuX.SETTLE_SMOOTH_100NA is disabled by default in the 2601B, 2602B, 2604B, 2611B, 2612B, and 2614B. In the 2634B, 2635B, and 2636B, it is always enabled.", - "param_info": [ - { - "name": "settleOption", - "description": "Set to the source settling mode. Set to one of the following values", - "enum": "smub.SETTLE_SMOOTH nil|smub.SETTLE_FAST_RANGE nil|smub.SETTLE_FAST_POLARITY nil|smub.SETTLE_DIRECT_IRANGE nil|smub.SETTLE_SMOOTH_100NA nil|smub.SETTLE_FAST_ALL nil|smub.SETTLE_FAST_ nil", - "type": "smubsourcesettlingsettleOption", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.settling applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.settling applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "settleOption = smub.source.settling", - "smub.source.settling = settleOption" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.settling = smua.SETTLE_FAST_POLARITY;", - "description": "Selects fast polarity changing for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Range" - ] - }, - { - "name": "smua.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuasourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smua.source.sink", - "smua.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smub.source.sink", - "webhelpfile": "15155.htm", - "signature": "", - "command_return": "sinkMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns sink mode on or off.", - "details": "This attribute enables or disables sink mode. When sink mode is enabled, it reduces the source limit inaccuracy that occurs when operating in quadrants II and IV (quadrants I and III show this source limit\u00a0inaccuracy).", - "param_info": [ - { - "name": "sinkMode", - "description": "Sets the sink mode on or off; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubsourcesinksinkMode", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "sinkMode = smub.source.sink", - "smub.source.sink = sinkMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.sink = smua.ENABLE;", - "description": "Enables sink mode for SMU channel\u00a0A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operating boundaries" - ] - }, - { - "name": "smua.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smua.trigger.arm.count", - "smua.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smub.trigger.arm.count", - "webhelpfile": "15156.htm", - "signature": "", - "command_return": "triggerArmCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the arm count in the trigger model.", - "details": "During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerArmCount", - "description": "The arm count in the trigger model", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "triggerArmCount = smub.trigger.arm.count", - "smub.trigger.arm.count = triggerArmCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.count = 5;", - "description": "Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.count" - ] - }, - { - "name": "smua.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smua.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.arm.set()", - "webhelpfile": "15157.htm", - "signature": "smub.trigger.arm.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the arm event detector to the detected state.", - "details": "The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated.A typical example that uses this function is when you want the SMU to immediately perform an action the first time through the trigger model, even if a programmed trigger event does not occur. This function start actions on the SMU if a trigger event is missed.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.arm.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.set();", - "description": "Sets the arm event detector to the detected state for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.arm.stimulus", - "smua.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.arm.stimulus", - "webhelpfile": "15158.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the arm event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event.Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the arm detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.arm.stimulus", - "smub.trigger.arm.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.arm.stimulus = trigger.timer[1].EVENT_ID;", - "description": "An event on trigger timer 1 causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smuatriggerARMED_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.ARMED_EVENT_ID", - "webhelpfile": "15159.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the number of the armed event.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to armed events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The armed event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)", - "enum": "trigger.ARMED_EVENT_ID nil", - "type": "smubtriggerARMED_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.ARMED_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID;", - "description": "Trigger timer when the SMU passes through the arm layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smua.trigger.autoclear", - "smua.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.autoclear", - "webhelpfile": "15160.htm", - "signature": "", - "command_return": "autoClear", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute turns automatic clearing of the event detectors on or off.", - "details": "This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.Only the detected states of the event detectors are cleared.The overrun statuses of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.The event detectors are always cleared when a sweep is initiated.", - "param_info": [ - { - "name": "autoClear", - "description": "Auto clear setting; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggerautoclearautoClear", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "autoClear = smub.trigger.autoclear", - "smub.trigger.autoclear = autoClear" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.autoclear = smua.ENABLE;", - "description": "Automatically clear the event detectors for the trigger mode state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smua.trigger.count", - "smua.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.count", - "webhelpfile": "15161.htm", - "signature": "", - "command_return": "triggerCount", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger count in the trigger model.", - "details": "During a sweep, the SMU iterates through the trigger layer of the trigger model the number of times set by this attribute. After performing the iterations, the SMU returns to the arm layer.If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.", - "param_info": [ - { - "name": "triggerCount", - "description": "The trigger count is the number of times the source\u2011measure unit (SMU) iterates in the trigger layer for any given sweep", - "enum": "", - "type": "integer", - "range": "(SMU)" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.trigger.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(for example, smua.trigger.count applies to SMU channel A)" - } - ], - "usage": [ - "triggerCount = smub.trigger.count", - "smub.trigger.count = triggerCount" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smua.SOURCE_IDLE1 nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smua.trigger.endpulse.action", - "smua.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.action", - "webhelpfile": "15162.htm", - "signature": "", - "command_return": "pulseAction", - "type": "Attribute (RW)", - "default_value": "1 (smuX.SOURCE_HOLD)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables pulse mode sweeps.", - "details": "When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.", - "param_info": [ - { - "name": "pulseAction", - "description": "The pulse mode setting; set to one of the following values (see Details for\u00a0definition)", - "enum": "smub.SOURCE_IDLE1 nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendpulseactionpulseAction", - "range": "(see Details for\u00a0definition)" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "pulseAction = smub.trigger.endpulse.action", - "smub.trigger.endpulse.action = pulseAction" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smua.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.set()", - "webhelpfile": "15163.htm", - "signature": "smub.trigger.endpulse.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the end pulse event detector to the detected state.", - "details": "This function sets the end pulse event detector to the detected state.The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. Therefore, call smuX.trigger.endpulse.set() after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.endpulse.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.endpulse.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.autoclear", - "smuX.trigger.initiate()", - "Triggering" - ] - }, - { - "name": "smua.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.endpulse.stimulus", - "smua.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endpulse.stimulus", - "webhelpfile": "15165.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the end pulse event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this value of this attribute to 0. Set eventID to one of the existing trigger event IDs, which are shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end pulse action of the source", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.endpulse.stimulus", - "smub.trigger.endpulse.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Configure the end pulse action to achieve a pulse and select the event, trigger.timer[1].EVENT_ID, that causes the arm event detector to enter the detected state.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smua.SOURCE_IDLE nil|smua.SOURCE_HOLD nil", - "type": "smuatriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.endsweep.action", - "smua.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.endsweep.action", - "webhelpfile": "15166.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.SOURCE_IDLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the action of the source at the end of a sweep.", - "details": "Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.", - "param_info": [ - { - "name": "action", - "description": "The source action at the end of a sweep; set to one of the following values", - "enum": "smub.SOURCE_IDLE nil|smub.SOURCE_HOLD nil", - "type": "smubtriggerendsweepactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.endsweep.action", - "smub.trigger.endsweep.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.endsweep.action = smua.SOURCE_IDLE;", - "description": "Sets SMU channel A to return the source back to the idle source level at the end of a sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smuatriggerIDLE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.IDLE_EVENT_ID", - "webhelpfile": "15167.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the idle event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to idle events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The idle event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.IDLE_EVENT_ID nil", - "type": "smubtriggerIDLE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.IDLE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID;", - "description": "Trigger timer 1 when the SMU returns to the idle layer.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smua.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.initiate()", - "webhelpfile": "15168.htm", - "signature": "smub.trigger.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates a sweep operation.", - "details": "This function causes the SMU to clear the four trigger model event detectors and enter its trigger model (moves the SMU from the idle state into the arm\u00a0layer).To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the following sweep source actions:To make measurements during the sweep, you must also configure and enable the measure action using smuX.trigger.measure.Y().If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers hold stale data. Use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.This function initiates an overlapped operation.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.initiate()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.initiate();", - "description": "Starts a preconfigured sweep and clears the event detectors for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "Configuring and running sweeps", - "smuX.trigger.measure.action", - "smuX.trigger.measure.Y()", - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil|smua.ASYNC nil", - "type": "smuatriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.measure.action", - "smua.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.action", - "webhelpfile": "15169.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute controls measurement actions during a sweep.", - "details": "With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.If this attribute is set to smuX.ASYNC:If any of the above items is incorrectly configured, the smuX.trigger.initiate() function generates an error.", - "param_info": [ - { - "name": "action", - "description": "The sweep measurement action; set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil|smub.ASYNC nil", - "type": "smubtriggermeasureactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.measure.action", - "smub.trigger.measure.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(smua.nvbuffer1);smua.trigger.measure.action = smua.ENABLE;", - "description": "Configure sweep voltage measurements.\n--- --Enable voltage measurements during the sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "smuX.trigger.autoclear", - "smuX.trigger.measure.Y()", - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smua.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smub.trigger.measure.set()", - "webhelpfile": "15170.htm", - "signature": "smub.trigger.measure.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the measurement event detector to the detected state.", - "details": "This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.For example, you might use this function to have the SMU immediately perform an action the first time through the trigger model, even if a programmed trigger event does not\u00a0occur.If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.measure.set() is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger\u00a0event.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is\u00a0initiated.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.measure.set()" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.set();", - "description": "Sets the measure event detector of SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.source.set()" - ] - }, - { - "name": "smua.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.measure.stimulus", - "smua.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.measure.stimulus", - "webhelpfile": "15171.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes the measure event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measurement event detector portion of the trigger model.Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following\u00a0table.", - "param_info": [ - { - "name": "eventID", - "description": "Event that triggers the measurement detector", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.measure.stimulus", - "smub.trigger.measure.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID;", - "description": "Sets delay before measurement begins on SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smua.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.v()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.v(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.v(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.i()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.i(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.i(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.r()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.r(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.r(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.p()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.p(rbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.p(rbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smub.trigger.measure.iv()", - "webhelpfile": "15172.htm", - "signature": "smub.trigger.measure.iv(ibuffer, vbuffer)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures the measurements that are to be made in a subsequent sweep.", - "details": "As measurements are made, they are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings are available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.If a given reading buffer contains any data, it is cleared before making any measurements, unless the reading buffer has been configured to append\u00a0data.The SMU only retains the last call to any one of these functions and only that measurement action is performed.After configuring the measurements to make with this function, enable the measurement action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU measurement type (v = voltage, i = current, r = resistance, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, r = resistance, p = power)" - }, - { - "name": "rbuffer", - "description": "A reading buffer object where the readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "ibuffer", - "description": "A reading buffer object where current readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "vbuffer", - "description": "A reading buffer object where voltage readings are stored", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.trigger.measure.iv(ibuffer, vbuffer)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.measure.v(vbuffername);smua.trigger.measure.action = smua.ENABLE;", - "description": "Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Reading buffers", - "smuX.measure.Y()", - "smuX.nvbufferY", - "smuX.trigger.measure.action", - "Sweep Operation", - "Triggering", - "waitcomplete()" - ] - }, - { - "name": "smua.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerMEASURE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.MEASURE_COMPLETE_EVENT_ID", - "webhelpfile": "15173.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the measurement complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to measure complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The measurement complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.MEASURE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerMEASURE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.MEASURE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smuX.trigger.MEASURE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU completes a measurement.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerPULSE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.PULSE_COMPLETE_EVENT_ID", - "webhelpfile": "15174.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the pulse complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to pulse complete events.", - "param_info": [ - { - "name": "eventID", - "description": "The pulse complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.PULSE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerPULSE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.PULSE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.PULSE_COMPLETE_EVENT_ID;", - "description": "Trigger a timer when the SMU completes a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSOURCE_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SOURCE_COMPLETE_EVENT_ID", - "webhelpfile": "15175.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the source complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to source complete events from this source\u2011measure unit (SMU).", - "param_info": [ - { - "name": "eventID", - "description": "The source action complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SOURCE_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSOURCE_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SOURCE_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Trigger the timer when the SMU updates the source level or starts a pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smuatriggerSWEEP_COMPLETE_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEP_COMPLETE_EVENT_ID", - "webhelpfile": "15176.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweep complete event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweep complete events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweep complete event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEP_COMPLETE_EVENT_ID nil", - "type": "smubtriggerSWEEP_COMPLETE_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEP_COMPLETE_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[2].mode = digio.TRIG_RISINGA;digio.trigger[2].clear();smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;digio.trigger[4].mode = digio.TRIG_RISINGM;digio.trigger[4].pulsewidth = 0.001;digio.trigger[4].stimulus = smua.trigger.SWEEP_COMPLETE_EVENT_ID;", - "description": "Configure the 2600B to detect a rising edge on digital I/O line 2.\n--- --Configure SMU A to start its source action when a trigger event occurs on digital I/O line 2.\n--- --Configure digital I/O line 4 to output a 1 ms rising-edge trigger pulse at the completion of the SMU sweep.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smuatriggerSWEEPING_EVENT_IDa", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.SWEEPING_EVENT_ID", - "webhelpfile": "15177.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the sweeping event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to sweeping events from this SMU.", - "param_info": [ - { - "name": "eventID", - "description": "The sweeping event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)", - "enum": "trigger.SWEEPING_EVENT_ID nil", - "type": "smubtriggerSWEEPING_EVENT_IDb", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.SWEEPING_EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "reset();period_timer = trigger.timer[1];pulse_timer = trigger.timer[2];smua.trigger.source.listv( {5} );smua.trigger.source.action = smua.ENABLE;smua.source.rangev = 5;smua.trigger.measure.action = smua.DISABLE;pulse_timer.delay = 0.0006;pulse_timer.stimulus = period_timer.EVENT_ID;pulse_timer.count = 1;period_timer.delay = 0.005;period_timer.count = 9;period_timer.stimulus = smua.trigger.SWEEPING_EVENT_ID;period_timer.passthrough = true;smua.trigger.source.stimulus = period_timer.EVENT_ID;smua.trigger.endpulse.action = smua.SOURCE_IDLE;smua.trigger.endpulse.stimulus = pulse_timer.EVENT_ID;smua.trigger.count = 1;smua.trigger.arm.count = 10;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();waitcomplete();smua.source.output = smua.OUTPUT_OFF;", - "description": "Generate a 10-point pulse train where each pulse has a width of 600\u00a0\u00b5s and a pulse period of 5\u00a0ms.\n--- --Alias the trigger timers to use for pulse width and period.\n--- --Create a fixed level voltage sweep.\n--- --Set the pulse width and trigger the pulse width timer with a period timer.\n--- --Set the pulse period to output one pulse per period and the count to generate 10 pulses.\n--- --Trigger the pulse period timer when a sweep is initiated.\n--- --Configure the timer to output a trigger event when it starts the first delay.\n--- --Trigger the SMU source action using pulse period timer.\n--- --Trigger the SMU end pulse action using pulse width timer.\n--- --Set the trigger model counts.\n--- --Configure the SMU to execute a 10-point pulse train.\n--- --Start the trigger model.\n--- --Wait for the sweep to complete.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smua.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smua.DISABLE nil|smua.ENABLE nil", - "type": "smuatriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smua.trigger.source.action", - "smua.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.action", - "webhelpfile": "15178.htm", - "signature": "", - "command_return": "action", - "type": "Attribute (RW)", - "default_value": "0 (smuX.DISABLE)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables sweeping the source (on or off).", - "details": "This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().", - "param_info": [ - { - "name": "action", - "description": "Sweep source action. Set to one of the following values", - "enum": "smub.DISABLE nil|smub.ENABLE nil", - "type": "smubtriggersourceactionaction", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "action = smub.trigger.source.action", - "smub.trigger.source.action = action" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});smua.trigger.source.action = smua.ENABLE;", - "description": "Configure list sweep for SMU channel A (sweep through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V).\n--- --Enable the source action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limitv", - "smua.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smua.LIMIT_AUTO nil", - "type": "smuatriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smua.trigger.source.limiti", - "smua.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limitv", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitvsweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limitv", - "smub.trigger.source.limitv = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.limiti", - "webhelpfile": "15179.htm", - "signature": "", - "command_return": "sweepSourceLimit", - "type": "Attribute (RW)", - "default_value": "0 (smuX.LIMIT_AUTO)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the sweep source limit.", - "details": "Use this attribute to perform extended operating area pulse mode sweeps.If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU uses the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU switches in this limit at the start of the source action and returns to the normal limit setting at the end of the end pulse action.Normally, the limit range is automatically adjusted in accordance with the limit value. During sweeping, however, the limit range is fixed to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). The minimum limit value that can be enforced during the sweep is equal to 10% of the full\u2011scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10% value is enforced instead. Likewise, if the limit value falls below the 10% threshold as a result of power compliance, the 10% value is enforced\u00a0instead.When using the extended operating area, the SMU automatically starts the end pulse action if the SMU is not triggered before its maximum pulse width. It also delays the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.", - "param_info": [ - { - "name": "sweepSourceLimit", - "description": "The source limit that is used during triggered operation; set to", - "enum": "smub.LIMIT_AUTO nil", - "type": "smubtriggersourcelimitisweepSourceLimit", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU output function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - } - ], - "usage": [ - "sweepSourceLimit = smub.trigger.source.limiti", - "smub.trigger.source.limiti = sweepSourceLimit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.limitv = 10;", - "description": "Sets the voltage sweep limit to 10\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Configuring and running sweeps", - "smuX.source.limitY", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smua.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.linearv()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.linearv(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.linearv(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smub.trigger.source.lineari()", - "webhelpfile": "15180.htm", - "signature": "smub.trigger.source.lineari(startValue, endValue, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures a linear source sweep.", - "details": "This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source generates a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep. Instead, it is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With linear sweeps, it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.lineari(startValue, endValue, points)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.linearv(0, 10, 11);", - "description": "Sweeps from 0\u00a0V to 10\u00a0V in 1\u00a0V steps.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.listY()", - "smuX.trigger.source.logY()", - "Sweep Operation" - ] - }, - { - "name": "smua.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smua.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listv()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listv(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listv(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.listi()", - "webhelpfile": "15181.htm", - "signature": "smub.trigger.source.listi(sweepList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an array-based source sweep.", - "details": "This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source outputs the sequence of source values given in the sweepList\u00a0array.If the subsequent sweep has more points than specified in sweepList, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in sweepList, the extra values are ignored. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.The SMU only stores the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "sweepList", - "description": "An array of source values", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.listi(sweepList)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.listv({3, 1, 4, 5, 2});", - "description": "Sweeps SMU channel A through 3\u00a0V, 1\u00a0V, 4\u00a0V, 5\u00a0V, and 2\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.logY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smua.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smua.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logv()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logv(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logv(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smub.trigger.source.logi()", - "webhelpfile": "15182.htm", - "signature": "smub.trigger.source.logi(startValue, endValue, points, asymptote)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function configures an exponential (geometric) source sweep.", - "details": "This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.The asymptote parameter customizes the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.Source functions cannot be changed within a sweep.After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.", - "param_info": [ - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU source function (v = voltage, i = current)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current)" - }, - { - "name": "startValue", - "description": "Source value of the first point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "endValue", - "description": "Source value of the last point", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "The number of points used to calculate the step size", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "asymptote", - "description": "The asymptotic offset value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "smub.trigger.source.logi(startValue, endValue, points, asymptote)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.logv(1, 10, 11, 0);", - "description": "Sweeps SMU channel A from 1\u00a0V to 10\u00a0V in 10 steps with an asymptote of 0\u00a0V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.source.action", - "smuX.trigger.source.linearY()", - "smuX.trigger.source.listY()", - "Sweep operation" - ] - }, - { - "name": "smua.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smua.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smua.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smub.trigger.source.set()", - "webhelpfile": "15183.htm", - "signature": "smub.trigger.source.set()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the source event detector to the detected state.", - "details": "This function sets the source event detector to the detected state.The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. Call this function after the sweep is initiated. If the event detectors are configured to clear automatically because the smuX.trigger.autoclear attribute is set to smuX.ENABLE, make sure that smuX.trigger.source.set() is issued after the SMU has entered the trigger layer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "smub.trigger.source.set()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.trigger.source.listv({5});smua.trigger.source.stimulus = display.trigger.EVENT_ID;smua.source.output = smua.OUTPUT_ON;smua.trigger.initiate();delay(1);-- Continue even if the display trigger key was not pressed.;smua.trigger.source.set();waitcomplete();", - "description": "Sets the source event detector.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.trigger.arm.set()", - "smuX.trigger.autoclear", - "smuX.trigger.endpulse.set()", - "smuX.trigger.initiate()", - "smuX.trigger.measure.set()", - "Triggering" - ] - }, - { - "name": "smua.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smua.trigger.source.stimulus", - "smua.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "smub.trigger.source.stimulus", - "webhelpfile": "15184.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines which event causes the source event detector to enter the detected state.", - "details": "Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set the value of this attribute to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "Set to the event that triggers the end\u2011pulse source off action", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "eventID = smub.trigger.source.stimulus", - "smub.trigger.source.stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID;", - "description": "Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Triggering" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "15280.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.If no name is specified, the script is loaded as the anonymous script.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, script)", - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [ - "tspnet.tsp.runscript(connectionID, script)" - ], - "examples": [ - { - "example": "tspnet.tsp.runscript(myconnection, \"mytest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled mytest on the TSP\u2011enabled instrument connected with myconnection.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "timer.measure.t()", - "webhelpfile": "15281.htm", - "signature": "timer.measure.t()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function measures the elapsed time since the timer was last reset.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.measure.t()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "This example resets the timer and measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The output varies. The above output indicates that timer.measure.t() was executed 14.69077\u00a0seconds after timer.reset().\n" - }, - { - "example": "beeper.enable = beeper.ON;beeper.beep(0.5, 2400);print(\"reset timer\");timer.reset();delay(0.5);dt = timer.measure.t();print(\"timer after delay:\", dt);beeper.beep(0.5, 2400);", - "description": "Enable the beeper.\n--- --Emit a beep and set the beeper.\n--- --Reset the timer.\n--- --Set a delay.\n--- --Verify the duration of the delay before emitting another beep.\n--- --Output:\n--- --reset timer\n--- --timer after delay: 5.00e-01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.reset()" - ] - }, - { - "name": "timer.reset()", - "webhelpfile": "15282.htm", - "signature": "timer.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "timer.reset()-- (intervening code)time = timer.measure.t()print(time)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the timer and then measures the time since the reset.Output:1.469077e+01The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "timer.reset();-- (intervening code);time = timer.measure.t();print(time);", - "description": "Resets the timer and then measures the time since the reset.\n--- --Output:\n--- --1.469077e+01\n--- --The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "timer.measure.t()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP\u2011Link node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "15286.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command sets the TSP\u2011Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP\u2011Link instrument is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 64 )", - "enum": "", - "type": "number", - "range": "(1 to 64 )" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP\u2011Link node for this instrument to number\u00a03.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.reset()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readbit()", - "webhelpfile": "15288.htm", - "signature": "tsplink.readbit(N)", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the state of a TSP-Link synchronization line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Returns a value of zero (0) if the line is low and 1 if the line is high.", - "param_info": [ - { - "name": "data", - "description": "The state of the synchronization line", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - } - ], - "usage": [ - "data = tsplink.readbit(N)" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readbit(3);print(data);", - "description": "Assume line 3 is set high, and it is then read.\n--- --Output:\n--- --1.000000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readport()", - "tsplink.writebit()" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP-Link trigger lines", - "tsplink.readbit()", - "tsplink.writebit() ", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.reset()", - "webhelpfile": "15290.htm", - "signature": "tsplink.reset(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes (resets) all nodes (instruments) in the TSP\u2011Link system. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function erases all information regarding other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link must be reset again.If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP\u2011Link network.If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 does not generate any errors, even if there are no other nodes on the TSP-Link network.Also returns the number of nodes found.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes actually found on the system", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 64)", - "enum": "", - "type": "number", - "range": "(1 to 64)" - } - ], - "usage": [ - "nodesFound = tsplink.reset()", - "nodesFound = tsplink.reset(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.reset()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.reset(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link reset and indicate how many nodes are found.\n--- --Sample output if two nodes are found:Nodes found = 2\n--- --Sample output if fewer nodes are found and if localnode.showerrors = 1:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "localnode.showerrors", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP\u2011Link online state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "string", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP\u2011Link system. If it is online, the output is:\n--- --online\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.node", - "tsplink.reset()" - ] - }, - { - "name": "tsplink.trigger[N].assert()", - "webhelpfile": "15292.htm", - "signature": "tsplink.trigger[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event ID. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].clear()", - "webhelpfile": "15293.htm", - "signature": "tsplink.trigger[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The trigger event detector enters the detected state when an event is detected. tsplink.trigger[N].clear() clears a trigger event detector, discards the history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[2].clear();", - "description": "Clears trigger event on synchronization line 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].EVENT_ID", - "webhelpfile": "15294.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the number that is used for the trigger events. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This number is used by the TSP-Link trigger line when it detects an input trigger.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this line.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "tsplink.trigger[N].mode", - "webhelpfile": "15295.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "0 (tsplink.TRIG_BYPASS)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation and detection mode. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger\u00a0line.The setting for the mode parameter can be one of the values shown in the following table.When programmed to any mode except tsplink.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic and the user-specified output state of the line is\u00a0ignored.When the trigger mode is set to tsplink.TRIG_RISING, the user\u2011specified output state of the line is examined. If the output state selected when the mode is changed is high, the actual mode that is used is tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode that is used is tsplink.TRIG_RISINGM.The mode parameter stores the trigger mode as a numeric value when the attribute is read.To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.trigger[N].mode", - "tsplink.trigger[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].mode = tsplink.TRIG_RISINGM;", - "description": "Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.writebit()", - "digio.writeport()", - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].overrun", - "webhelpfile": "15296.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = tsplink.trigger[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[1].overrun);", - "description": "If an event was ignored, displays true; if an event was not ignored, displays false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].release()", - "tsplink.trigger[N].reset()", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].pulsewidth", - "webhelpfile": "15297.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (in seconds)", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].release()" - ] - }, - { - "name": "tsplink.trigger[N].release()", - "webhelpfile": "15298.htm", - "signature": "tsplink.trigger[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP\u2011Link trigger line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].clear()", - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus", - "tsplink.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].wait()", - "webhelpfile": "15300.htm", - "signature": "tsplink.trigger[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = tsplink.trigger[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = tsplink.trigger[3].wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger on TSP-Link\u00ae line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].clear()" - ] - }, - { - "name": "tsplink.writebit()", - "webhelpfile": "15301.htm", - "signature": "tsplink.writebit(N, data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets a TSP-Link trigger line high or low. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.If the output line is write\u2011protected by the tsplink.writeprotect attribute, this command is ignored.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "number", - "range": "(1 to 3)" - }, - { - "name": "data", - "description": "The value to write to the bit", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "tsplink.writebit(N, data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writebit(3, 0);", - "description": "Sets trigger line 3 low (0).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writeport()", - "tsplink.writeprotect" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP\u2011Link synchronization lines. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).Write\u2011protected lines are not changed.Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeprotect" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].EVENT_ID", - "webhelpfile": "15786.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the trigger blender event number.", - "details": "Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to trigger events from this trigger blender.", - "param_info": [ - { - "name": "eventID", - "description": "Trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "eventID = trigger.blender[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND mode)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line\u00a03\u00a0or\u00a05.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "15790.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to six) on which to wait", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.\n--- --Wait three seconds while checking if trigger blender 1 event has occurred.\n--- --If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "15791.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears the command interface trigger event detector.", - "details": "The trigger event detector indicates if a trigger event has been detected since the last trigger.wait() call. trigger.clear() clears the trigger event detector and discards the history of command interface trigger events.", - "param_info": [], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.EVENT_ID", - "webhelpfile": "15792.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant contains the command interface trigger event number.", - "details": "You can set the stimulus of any trigger object to the value of this constant to have the trigger object respond to command interface trigger events.", - "param_info": [ - { - "name": "eventID", - "description": "The event ID for the command interface triggers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "eventID = EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = trigger.EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that is used the next time the timer is triggered.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (0.5 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(0.5 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be \u2265\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --Read the delay list on trigger timer\u00a03.\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].EVENT_ID", - "webhelpfile": "15796.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant specifies the trigger timer event number.", - "details": "This constant is an identification number that identifies events generated by this timer.Set the stimulus of any trigger object to the value of this constant to have the trigger object respond to events from this timer.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID;", - "description": "Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].overrun", - "webhelpfile": "15797.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "false\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.Delay overrun indications are provided in the status model.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.timer[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].passthrough", - "webhelpfile": "15798.htm", - "signature": "", - "command_return": "passthrough", - "type": "Attribute (RW)", - "default_value": "false (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the timer trigger pass\u2011through mode.", - "details": "When pass-through mode is enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.", - "param_info": [ - { - "name": "passthrough", - "description": "The state of pass-through mode; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "passthrough = trigger.timer[N].passthrough", - "trigger.timer[N].passthrough = passthrough" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].passthrough = true;", - "description": "Enables pass\u2011through mode on trigger timer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "15801.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a command interface trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "true", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 seconds for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u2011second timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "status.node_enable", - "webhelpfile": "15830.htm", - "signature": "", - "command_return": "nodeEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the system node enable register. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitAssigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set the B0 bit of the system node enable register, set status.node_enable\u00a0=\u00a0status.MSB.In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "nodeEnableRegister", - "description": "The status of the system node enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEnableRegister = status.node_enable", - "status.node_enable = nodeEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEnableRegister = status.MSB + status.OSB;status.node_enable = nodeEnableRegister;", - "description": "Use constants to set the MSB and OSB bits of the system node enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;nodeEnableRegister = 129;status.node_enable = nodeEnableRegister;", - "description": "Sets the MSB and OSB bits of the system node enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "status.node_event", - "webhelpfile": "15831.htm", - "signature": "", - "command_return": "nodeEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status node event register.", - "details": "This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "nodeEventRegister", - "description": "The status of the node event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "nodeEventRegister = status.node_event" - ], - "overloads": [], - "examples": [ - { - "example": "nodeEventRegister = status.node_event;print(nodeEventRegister);", - "description": "Reads the status node event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001. Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ntr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.ptr", - "webhelpfile": "15833.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status register set of the status model.", - "details": "These attributes read or write the operation status registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101\u00a00000\u00a00000\u00a00000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4,096 + 16,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition", - "operationRegister = status.operation.enable", - "operationRegister = status.operation.event", - "operationRegister = status.operation.ntr", - "operationRegister = status.operation.ptr", - "status.operation.enable = operationRegister", - "status.operation.ntr = operationRegister", - "status.operation.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.USER + status.operation.PROG;status.operation.enable = operationRegister;", - "description": "Uses constants to set the USER and PROG bits of the operation status enable register.\n" - }, - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Uses a decimal value to set the USER and PROG bits of the operation status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers" - ] - }, - { - "name": "status.operation.instrument.digio.condition", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.enable", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.event", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ntr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.ptr", - "webhelpfile": "15836.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constant, operationRegister can be set to the decimal value of the bit to set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digital I/O summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.condition", - "operationRegister = status.operation.instrument.digio.enable", - "operationRegister = status.operation.instrument.digio.event", - "operationRegister = status.operation.instrument.digio.ntr", - "operationRegister = status.operation.instrument.digio.ptr", - "status.operation.instrument.digio.enable = operationRegister", - "status.operation.instrument.digio.ntr = operationRegister", - "status.operation.instrument.digio.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.digio.enable = status.operation.instrument.digio.TRGOVR;", - "description": "Uses a constant to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - }, - { - "example": "status.operation.instrument.digio.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status digital I/O summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.condition", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.enable", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.event", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ntr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.digio.trigger_overrun.ptr", - "webhelpfile": "15837.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status digital I/O overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitA set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status digio I/O overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.digio.trigger_overrun.condition", - "operationRegister = status.operation.instrument.digio.trigger_overrun.enable", - "operationRegister = status.operation.instrument.digio.trigger_overrun.event", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.digio.trigger_overrun.ptr", - "status.operation.instrument.digio.trigger_overrun.enable = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.digio.trigger_overrun.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.digio.trigger_overrun.LINE1 +; status.operation.instrument.digio.trigger_overrun.LINE10;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.digio.trigger_overrun.enable = operationRegister;", - "description": "Uses the decimal value to set bit B1 and bit B10 of the operation status digital I/O overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.digio.*" - ] - }, - { - "name": "status.operation.instrument.lan.condition", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.enable", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.event", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ntr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.ptr", - "webhelpfile": "15838.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN summary register set.", - "details": "These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.condition", - "operationRegister = status.operation.instrument.lan.enable", - "operationRegister = status.operation.instrument.lan.event", - "operationRegister = status.operation.instrument.lan.ntr", - "operationRegister = status.operation.instrument.lan.ptr", - "status.operation.instrument.lan.enable = operationRegister", - "status.operation.instrument.lan.ntr = operationRegister", - "status.operation.instrument.lan.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.CONF +; status.operation.instrument.lan.TRGOVR;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - }, - { - "example": "operationRegister = 1026;status.operation.instrument.lan.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B10 of the operation status LAN summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.condition", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.enable", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.event", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ntr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.lan.trigger_overrun.ptr", - "webhelpfile": "15839.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status LAN trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000\u00a00001\u00a00000\u00a00010. This value indicates that bit B1 and bit B8 are set.* Least significant bit** Most significant bitA set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status LAN trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.lan.trigger_overrun.condition", - "operationRegister = status.operation.instrument.lan.trigger_overrun.enable", - "operationRegister = status.operation.instrument.lan.trigger_overrun.event", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.lan.trigger_overrun.ptr", - "status.operation.instrument.lan.trigger_overrun.enable = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.lan.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.lan.trigger_overrun.LAN1 +; status.operation.instrument.lan.trigger_overrun.LAN8;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use constants to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - }, - { - "example": "operationRegister = 258;status.operation.instrument.lan.trigger_overrun.enable = operationRegister;", - "description": "Use the decimal value to set bit B1 and bit B8 of the operation status LAN trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.lan.*" - ] - }, - { - "name": "status.operation.instrument.smua.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.condition", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.enable", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.event", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ntr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smub.ptr", - "webhelpfile": "15840.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X summary register set.", - "details": "These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1,025) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B0 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1,025 (which is the sum of 1 + 1,024). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel\u00a0A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.condition", - "operationRegister = status.operation.instrument.smuX.enable", - "operationRegister = status.operation.instrument.smuX.event", - "operationRegister = status.operation.instrument.smuX.ntr", - "operationRegister = status.operation.instrument.smuX.ptr", - "status.operation.instrument.smuX.enable = operationRegister", - "status.operation.instrument.smuX.ntr = operationRegister", - "status.operation.instrument.smuX.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.enable = status.operation.instrument.smua.MEAS;", - "description": "Use a constant to set bit B4 of the operation status SMU A summary enable register.\n" - }, - { - "example": "status.operation.instrument.smua.enable = 1025;", - "description": "Use the decimal value to set bits B0 and B10 of the operation status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.trigger_overrrun.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smua.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.condition", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.enable", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.event", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ntr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.smub.trigger_overrrun.ptr", - "webhelpfile": "15841.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status SMU X trigger overrun register set.", - "details": "These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable\u00a0=\u00a0 status.operation.instrument.smua.trigger_overrun.ARM.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status SMU X trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.smuX.trigger_overrun.condition", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.enable", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.event", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr", - "status.operation.instrument.smuX.trigger_overrun.enable = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.smua.trigger_overrun.enable =; status.operation.instrument.smua.trigger_overrun.ARM;", - "description": "Uses a constant to sets the ARM bit of the operation status SMU A trigger overrun enable register.\n" - }, - { - "example": "status.operation.instrument.smua.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set bits B1 and B4 of the operation status SMU A trigger overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.smuX.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.condition", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.enable", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.event", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ntr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.ptr", - "webhelpfile": "15842.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender summary register set.", - "details": "These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_blender.condition", - "operationRegister = status.operation.instrument.trigger_blender.enable", - "operationRegister = status.operation.instrument.trigger_blender.event", - "operationRegister = status.operation.instrument.trigger_blender.ntr", - "operationRegister = status.operation.instrument.trigger_blender.ptr", - "status.operation.instrument.trigger_blender.enable = operationRegister", - "status.operation.instrument.trigger_blender.ntr = operationRegister", - "status.operation.instrument.trigger_blender.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.enable = 1024;", - "description": "Uses a decimal value to set the TRGOVR bit of the operation status trigger blender summary enable.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.condition", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.enable", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.event", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ntr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.ptr", - "webhelpfile": "15844.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.trigger_timer.condition", - "operationRegister = status.operation.instrument.trigger_timer.enable", - "operationRegister = status.operation.instrument.trigger_timer.event", - "operationRegister = status.operation.instrument.trigger_timer.ntr", - "operationRegister = status.operation.instrument.trigger_timer.ptr", - "status.operation.instrument.trigger_timer.enable = operationRegister", - "status.operation.instrument.trigger_timer.ntr = operationRegister", - "status.operation.instrument.trigger_timer.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.enable = 1024;", - "description": "Uses the decimal value to set the TRGOVR bit of the operation status trigger timer summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.condition", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.enable", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.event", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "webhelpfile": "15845.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger timer overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger timer trigger overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.condition", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.enable", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.event", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ntr", - "operationRegister = ", - " status.operation.instrument.trigger_timer.trigger_overrun.ptr", - "status.operation.instrument.trigger_timer.trigger_overrun.enable = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ntr = ", - " operationRegister", - "status.operation.instrument.trigger_timer.trigger_overrun.ptr = ", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable =; status.operation.instrument.trigger_timer.trigger_overrun.TMR3;", - "description": "Uses a constant to set the timer 3 bit of the operation status trigger timer overrun enable\u00a0register.\n" - }, - { - "example": "status.operation.instrument.trigger_timer.trigger_overrun.enable = 18;", - "description": "Uses a constant to set timer bits B1 and B4 of the operation status trigger timer overrun enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.condition", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.enable", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.event", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ntr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.ptr", - "webhelpfile": "15846.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link summary register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to\u00a01024.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-Link summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.tsplink.condition", - "operationRegister = status.operation.instrument.tsplink.enable", - "operationRegister = status.operation.instrument.tsplink.event", - "operationRegister = status.operation.instrument.tsplink.ntr", - "operationRegister = status.operation.instrument.tsplink.ptr", - "status.operation.instrument.tsplink.enable = operationRegister", - "status.operation.instrument.tsplink.ntr = operationRegister", - "status.operation.instrument.tsplink.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.enable = 1024;", - "description": "Uses the decimal value to set the trigger overrun bit of the operation status TSP-Link summary enable\u00a0register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.tsplink.trigger_overrun.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.condition", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.enable", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.event", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ntr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.instrument.tsplink.trigger_overrun.ptr", - "webhelpfile": "15847.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status TSP-Link overrun register set. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00000\u00a01010. This value indicates that bit B1 and bit B3 are set.* Least significant bit** Most significant bitA set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status TSP-link overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.tsplink.trigger_overrun.condition", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.event", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr", - "operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr", - "status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister", - "status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable =; status.operation.instrument.tsplink.trigger_overrun.LINE1;", - "description": "Uses a constant to set the line 1 bit of the operation status TSP-Link overrun enable register.\n" - }, - { - "example": "status.operation.instrument.tsplink.trigger_overrun.enable = 10;", - "description": "Uses the decimal value to set bits for lines 1 and 3 of the operation status TSP-Link overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_timer.*" - ] - }, - { - "name": "status.operation.remote.condition", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.enable", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.event", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ntr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.remote.ptr", - "webhelpfile": "15849.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status remote summary register set. ", - "details": "These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B1 and B11, set operationRegister to 2,050 (which is the sum of 2 + 2,048). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status remote summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.remote.condition", - "operationRegister = status.operation.remote.enable", - "operationRegister = status.operation.remote.event", - "operationRegister = status.operation.remote.ntr", - "operationRegister = status.operation.remote.ptr", - "status.operation.remote.enable = operationRegister", - "status.operation.remote.ntr = operationRegister", - "status.operation.remote.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.remote.enable = status.operation.remote.CAV;", - "description": "Uses a constant to set the CAV bit, B1, of the operation status remote summary enable register.\n" - }, - { - "example": "status.operation.remote.enable = 2050;", - "description": "Uses the decimal value to set bits B1 and B11 of the operation status remote summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.condition", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.enable", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.event", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ntr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.user.ptr", - "webhelpfile": "15852.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the operation status user register set of the status model.", - "details": "These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bits B0 and B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.In addition to the above constants, operationRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal values. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2,048\u00a0+\u00a016,384). ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status user register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.user.condition", - "operationRegister = status.operation.user.enable", - "operationRegister = status.operation.user.event", - "operationRegister = status.operation.user.ntr", - "operationRegister = status.operation.user.ptr", - "status.operation.user.condition = operationRegister", - "status.operation.user.enable = operationRegister", - "status.operation.user.ntr = operationRegister", - "status.operation.user.ptr = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.user.BIT11 + status.operation.user.BIT14;status.operation.user.enable = operationRegister;", - "description": "Uses constants to set bits B11 and B14 of the operation status user enable register.\n" - }, - { - "example": "-- 18432 = binary 0100 1000 0000 0000;operationRegister = 18432;status.operation.enable = operationRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the operation status user enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ntr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.ptr", - "webhelpfile": "15853.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the questionable status register set of the status model.", - "details": "These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011\u00a00000\u00a00000\u00a00000. This value indicates that bits B12 and B13 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set questionableRegister to 12,288 (which is the sum of 4,096 + 8,192). ", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition", - "questionableRegister = status.questionable.enable", - "questionableRegister = status.questionable.event", - "questionableRegister = status.questionable.ntr", - "questionableRegister = status.questionable.ptr", - "status.questionable.enable = questionableRegister", - "status.questionable.ntr = questionableRegister", - "status.questionable.ptr = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = status.questionable.OTEMP;", - "description": "Uses a constant to set the OTEMP bit of the questionable status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers" - ] - }, - { - "name": "status.questionable.instrument.smua.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smua.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.condition", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.enable", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.event", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ntr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.instrument.smub.ptr", - "webhelpfile": "15856.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status SMU X summary register set.", - "details": "These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000\u00a00011\u00a00000\u00a00000. This value indicates that bit B8 and bit B9 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.smuX.condition", - "questionableRegister = status.questionable.instrument.smuX.enable", - "questionableRegister = status.questionable.instrument.smuX.event", - "questionableRegister = status.questionable.instrument.smuX.ntr", - "questionableRegister = status.questionable.instrument.smuX.ptr", - "status.questionable.instrument.smuX.enable = questionableRegister", - "status.questionable.instrument.smuX.ntr = questionableRegister", - "status.questionable.instrument.smuX.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "questionableRegister = status.questionable.instrument.smua.CAL +; status.questionable.instrument.smua.UO;status.questionable.instrument.smua.enable = questionableRegister;", - "description": "Uses constants to set bit B8 and bit B9 of the questionable status SMU A summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.unstable_output.condition", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.enable", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.event", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ntr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.unstable_output.ptr", - "webhelpfile": "15858.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status unstable output summary register set.", - "details": "These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status unstable output summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status unstable output summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.unstable_output.condition", - "questionableRegister = status.questionable.unstable_output.enable", - "questionableRegister = status.questionable.unstable_output.event", - "questionableRegister = status.questionable.unstable_output.ntr", - "questionableRegister = status.questionable.unstable_output.ptr", - "status.questionable.unstable_output.enable = questionableRegister", - "status.questionable.unstable_output.ntr = questionableRegister", - "status.questionable.unstable_output.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.unstable_output.enable = status.questionable.unstable_output.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status unstable output summary enable register bit.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.reset()", - "webhelpfile": "15861.htm", - "signature": "status.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.", - "param_info": [ - { - "name": "status.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the instrument status model.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.reset();", - "description": "Resets the instrument status model.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status model" - ] - }, - { - "name": "status.standard.condition", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ntr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.standard.ptr", - "webhelpfile": "15862.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the standard event status register set of the status model.", - "details": "These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "standardRegister = status.standard.condition", - "standardRegister = status.standard.enable", - "standardRegister = status.standard.event", - "standardRegister = status.standard.ntr", - "standardRegister = status.standard.ptr", - "status.standard.enable = standardRegister", - "status.standard.ntr = standardRegister", - "status.standard.ptr = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.EXE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and EXE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 17 = binary 0001 0001;standardRegister = 17;status.standard.enable = standardRegister;", - "description": "Uses the decimal value to set the OPC and EXE bits of the standard event status enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Standard Event Register " - ] - }, - { - "name": "status.system.condition", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.enable", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.event", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ntr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system.ptr", - "webhelpfile": "15863.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 1 through 14. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system.condition", - "enableRegister = status.system.enable", - "enableRegister = status.system.event", - "enableRegister = status.system.ntr", - "enableRegister = status.system.ptr", - "status.system.enable = enableRegister", - "status.system.ntr = enableRegister", - "status.system.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system.NODE11 + status.system.NODE14;status.system.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.condition", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.enable", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.event", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ntr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system2.ptr", - "webhelpfile": "15864.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 15 through 28. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 2 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system2.condition", - "enableRegister = status.system2.enable", - "enableRegister = status.system2.event", - "enableRegister = status.system2.ntr", - "enableRegister = status.system2.ptr", - "status.system2.enable = enableRegister", - "status.system2.ntr = enableRegister", - "status.system2.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system2.NODE25 + status.system2.NODE28;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B11 and B14 of the system summary 2 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system2.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 2 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system.*", - "status.system3.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.condition", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.enable", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.event", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ntr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system3.ptr", - "webhelpfile": "15865.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 29 through 42. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0 and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 3 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system3.condition", - "enableRegister = status.system3.enable", - "enableRegister = status.system3.event", - "enableRegister = status.system3.ntr", - "enableRegister = status.system3.ptr", - "status.system3.enable = enableRegister", - "status.system3.ntr = enableRegister", - "status.system3.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system3.NODE39 + status.system3.NODE42;status.system3.enable = enableRegister;", - "description": "Uses constants to set bits B11 and B14 of the system summary 3 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system3.enable = enableRegister;", - "description": "Uses the decimal value to set bits B11 and B14 of the system summary 3 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system2.*", - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.condition", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.enable", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.event", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ntr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system4.ptr", - "webhelpfile": "15866.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 43 through 56. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00001. This value indicates that bit B0 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.In addition to the above constants, enableRegister can be set to the decimal value of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal values. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2,048 + 16,384). ", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 4 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system4.condition", - "enableRegister = status.system4.enable", - "enableRegister = status.system4.event", - "enableRegister = status.system4.ntr", - "enableRegister = status.system4.ptr", - "status.system4.enable = enableRegister", - "status.system4.ntr = enableRegister", - "status.system4.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system4.NODE53 + status.system4.NODE56;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bit B11 and bit B14 of the system summary 4 enable register.\n" - }, - { - "example": "-- decimal 18432 = binary 0100 1000 0000 0000;enableRegister = 18432;status.system4.enable = enableRegister;", - "description": "Uses a decimal value to set bit B11 and bit B14 of the system summary 4 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system3.*", - "status.system5.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.condition", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.enable", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.event", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ntr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "status.system5.ptr", - "webhelpfile": "15867.htm", - "signature": "", - "command_return": "enableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "These attributes manage the TSP-Link\u00ae system summary register of the status model for nodes 57 through 64. These commands are not available on the 2604B, 2614B, or 2634B.", - "details": "In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a01000\u00a00010. This value indicates that bit B1 and bit B7 are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "enableRegister", - "description": "The status of the system summary 5 register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "enableRegister = status.system5.condition", - "enableRegister = status.system5.enable", - "enableRegister = status.system5.event", - "enableRegister = status.system5.ntr", - "enableRegister = status.system5.ptr", - "status.system5.enable = enableRegister", - "status.system5.ntr = enableRegister", - "status.system5.ptr = enableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "enableRegister = status.system5.NODE57 + status.system5.NODE60;status.system2.enable = enableRegister ;", - "description": "Uses constants to set bits B1 and B4 of the system summary 5 enable register.\n" - }, - { - "example": "-- decimal 18 = binary 0000 0000 0001 0010;enableRegister = 18;status.system5.enable = enableRegister;", - "description": "Uses the decimal value to set bits B1 and B4 of the system summary 5 enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.system4.*", - "System summary and standard event registers" - ] - }, - { - "name": "script.restore()", - "webhelpfile": "16851.htm", - "signature": "script.restore(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function restores a script that was removed from the runtime environment.", - "details": "This command copies the script from nonvolatile memory into the runtime environment. It also creates a global variable with the same name as the name of the script.", - "param_info": [ - { - "name": "name", - "description": "The name of the script to be restored", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.restore(name)" - ], - "overloads": [], - "examples": [ - { - "example": "script.restore(\"test9\");", - "description": "Restores a script named test9 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.delete()" - ] - }, - { - "name": "scriptVar.autorun", - "webhelpfile": "16852.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "No\n", - "description": "This attribute controls the autorun state of a script.", - "details": "Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.The run order for autorun scripts is arbitrary, so make sure the run order is not important.The default value for scriptVar.autorun depends on how the script was loaded. The default is no if the script was loaded with loadscript or script.new(). It is yes for scripts loaded with loadandrunscript or script.newautorun().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "state", - "description": "String that indicates whether or not the script runs automatically when powered on", - "enum": "", - "type": "\"yes\"|\"no\"", - "range": "" - } - ], - "usage": [ - "scriptVar.autorun = state", - "state = scriptVar.autorun" - ], - "overloads": [], - "examples": [ - { - "example": "test5.autorun = \"yes\";test5.save();", - "description": "Assume a script named test5 is in the runtime environment.\n--- --The next time the instrument is turned on, test5 script automatically loads and runs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "16853.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from nonvolatile memory.", - "details": "", - "param_info": [ - { - "name": "scriptName", - "description": "The string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Delete user scripts from the instrument", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the factory script.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "script.user.catalog()", - "webhelpfile": "16862.htm", - "signature": "for name in script.user.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile\u00a0memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.user.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.user.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified (the file name parameter is an empty string), the script is saved to internal nonvolatile memory. Only a script with filename defined can be saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB\u00a0flash\u00a0drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Save a user script" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "16867.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (RW)(see Details)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the source code of a script.", - "details": "The loadscript or loadandrunscript and endscript keywords are not included in the source code. The body of the script is a single string with lines separated by the new line character.The instrument automatically stores the source for all scripts that are loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source", - "scriptVar.source = nil" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");print(test7.source);", - "description": "This example creates a script called test7 that displays a message on the front panel and retrieves the source code.\n--- --Output:\n--- --display.clear() display.settext('Hello from my test')\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "scriptVar.list()" - ] - }, - { - "name": "localnode.reset()", - "webhelpfile": "16978.htm", - "signature": "localnode.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the local node instrument.", - "details": "If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.A local node reset includes:A localnode.reset() is different than a reset() because reset() resets the entire system. When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().", - "param_info": [ - { - "name": "localnode.reset()", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Resets the local node.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.reset();", - "description": "Resets the local node.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "smuX.reset()" - ] - }, - { - "name": "script.anonymous", - "webhelpfile": "17040.htm", - "signature": "", - "command_return": "scriptVar", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This is a reference to the anonymous script.", - "details": "You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "table", - "range": "" - } - ], - "usage": [ - "scriptVar = script.anonymous" - ], - "overloads": [], - "examples": [ - { - "example": "script.anonymous.list();", - "description": "Displays the content of the anonymous\u00a0script.\n" - }, - { - "example": "print(script.anonymous.source);", - "description": "Retrieves the source of the anonymous\u00a0script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Anonymous scripts", - "scriptVar.autorun", - "scriptVar.list()", - "scriptVar.name", - "scriptVar.run()", - "scriptVar.save()", - "scriptVar.source" - ] - }, - { - "name": "display.getlastkey()", - "webhelpfile": "17047.htm", - "signature": "display.getlastkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the key code for the last pressed key.", - "details": "A history of the key code for the last pressed front\u2011panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, you must set display.locallockout to display.LOCK.The table below lists the keyCode value for each front\u2011panel action.You cannot use this function to track the OUTPUT ON/OFF controls for SMU\u00a0A or SMU\u00a0B.", - "param_info": [ - { - "name": "keyCode", - "description": "A returned value that represents the last front-panel key pressed; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.getlastkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.getlastkey();print(key);", - "description": "On the front panel, press the MENU key and then send the code shown here. This retrieves the key code for the last pressed key.\n--- --Output:\n--- --6.80000e+01\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.locallockout", - "display.sendkey()" - ] - }, - { - "name": "bufferVar.cachemode", - "webhelpfile": "17109.htm", - "signature": "bufferVar.cachemode", - "command_return": "cacheMode", - "type": "Attribute (RW)", - "default_value": "1 (enabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the reading buffer cache (on or off).", - "details": "Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).", - "param_info": [ - { - "name": "cacheMode", - "description": "The reading buffer cache mode; set to one of the following", - "enum": "", - "type": "0|1", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "cacheMode = bufferVar.cachemode", - "bufferVar.cachemode = cacheMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.cachemode = 1;", - "description": "Enables reading buffer cache of dedicated reading buffer 1 (source\u2011measure unit (SMU) channel\u00a0A).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clearcache()", - "bufferVar.fillmode", - "Reading buffers" - ] - }, - { - "name": "smua.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitv", - "smua.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limiti", - "smua.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smua.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smua.source.limitp", - "smua.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitv", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitv", - "smub.source.limitv = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limiti", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limiti", - "smub.source.limiti = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "smub.source.limitp", - "webhelpfile": "17115.htm", - "signature": "", - "command_return": "limit", - "type": "Attribute (RW)", - "default_value": "Limit voltage:\n2601B, 2602B, 2604B: 40 (40\u00a0V)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:20 (20\u00a0V)\nLimit current:\n2601B, 2602B, 2604B: 1\u00a0(1\u00a0A)2611B, 2612B, 2614B, 2634B, 2635B, 2636B:100e-3 (100 mA)\nLimit power: 0 (disabled)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets compliance limits.", - "details": "Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU always uses autoranging for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.Set this attribute in the test sequence before the turning the source on.Using a limit value of 0 results in error code 1102, \"Parameter too small,\" for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU adjusts the source limit where appropriate to limit the output to the specified power. The SMU uses the lower of the programmed compliance value (the compliance level that is if power compliance is disabled) or the limit calculated from the power compliance setting.Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.", - "param_info": [ - { - "name": "limit", - "description": "The compliance limit value; set to one of the following values", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "Y", - "description": "SMU function (v = voltage, i = current, p = power)", - "enum": "", - "type": "any", - "range": "(v = voltage, i = current, p = power)" - } - ], - "usage": [ - "limit = smub.source.limitp", - "smub.source.limitp = limit" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.limitv = 15;", - "description": "Sets the voltage limit of SMU channel\u00a0A to 15 V.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cDUT test connections\u201d in the Series 2600B User's Guide", - "smuX.source.compliance", - "smuX.source.func", - "smuX.source.output" - ] - }, - { - "name": "errorqueue.next()", - "webhelpfile": "17242.htm", - "signature": "errorqueue.next()", - "command_return": "errorCode, message, severity, errorNode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the oldest entry from the error queue and removes it from the queue.", - "details": "Entries are stored in a first-in, first-out (FIFO) queue. This function reads the oldest entry and removes it from the queue.Error codes and messages are listed in the Error summary list.If there are no entries in the queue, code 0, Queue is Empty, is returned.In an expanded system, each TSP\u2011Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated. The errorNode is always 1 on the 2604B/2614B/2634B.", - "param_info": [ - { - "name": "errorCode", - "description": "The error code number for the entry", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "message", - "description": "The message that describes the error code", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity level (0, 10, 20, 30, or 40); see Details for more information", - "enum": "", - "type": "string", - "range": "(0, 10, 20, 30, or 40)" - }, - { - "name": "errorNode", - "description": "The node number where the error originated", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "errorCode, message, severity, errorNode = errorqueue.next()" - ], - "overloads": [], - "examples": [ - { - "example": "errorcode, message = errorqueue.next();print(errorcode, message);", - "description": "Reads the oldest entry in the error queue. The output below indicates that the queue is empty.\n--- --Output:\n--- --0.00000e+00 Queue Is Empty\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Error queue", - "errorqueue.clear()", - "errorqueue.count", - "Error summary list" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "17593.htm", - "signature": "", - "command_return": "requestSRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) enable register.", - "details": "This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).", - "param_info": [ - { - "name": "requestSRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(SRQ)" - } - ], - "usage": [ - "requestSRQEnableRegister = status.request_enable", - "status.request_enable = requestSRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits of the service request (SRQ) enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)", - "status.condition", - "status.system.*" - ] - }, - { - "name": "status.request_event", - "webhelpfile": "17594.htm", - "signature": "", - "command_return": "requestSRQEventRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the service request (SRQ) event register.", - "details": "This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bits set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "requestSRQEventRegister", - "description": "The status of the request event register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "requestSRQEventRegister = status.request_event" - ], - "overloads": [], - "examples": [ - { - "example": "requestEventRegister = status.request_event;print(requestEventRegister);", - "description": "Reads the status request event register.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001.\n--- --Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "status.condition", - "status.system.*", - "Status byte and service request (SRQ)" - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Controlling digital I/O lines", - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "17668.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger timer settings to their factory defaults.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].overrun", - "trigger.timer[N].passthrough", - "trigger.timer[N].stimulus" - ] - }, - { - "name": "tsplink.trigger[N].reset()", - "webhelpfile": "17669.htm", - "signature": "tsplink.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:This also clears tsplink.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.trigger[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes back to factory default values.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].mode", - "tsplink.trigger[N].overrun", - "tsplink.trigger[N].pulsewidth", - "tsplink.trigger[N].stimulus" - ] - }, - { - "name": "lan.trigger[N].stimulus", - "webhelpfile": "17679.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the trigger event IDs, which are shown in the following table.Setting this attribute to zero disables automatic trigger generation.If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The LAN event identifier used to trigger the event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "triggerStimulus = lan.trigger[N].stimulus", - "lan.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID;", - "description": "Use timer 1 trigger event as the source for LAN packet 5 trigger\u00a0stimulus.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.trigger[N].assert()", - "lan.trigger[N].clear()", - "lan.trigger[N].connect()", - "lan.trigger[N].overrun", - "lan.trigger[N].wait()" - ] - }, - { - "name": "tsplink.trigger[N].stimulus", - "webhelpfile": "17682.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "eventID = tsplink.trigger[N].stimulus", - "tsplink.trigger[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(tsplink.trigger[3].stimulus);", - "description": "Prints the event that starts TSP-Link trigger line 3 action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "tsplink.trigger[N].assert()", - "tsplink.trigger[N].reset()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "17684.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event. The eventID parameter can be the event ID of any trigger event.Use zero to disable the blender input. The eventID parameter may be one of the existing trigger event IDs shown in the following table.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "An integer representing the trigger event blender (up to six)", - "enum": "", - "type": "any", - "range": "(up to six)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "eventID = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = digio.TRIG_FALLING;digio.trigger[5].mode = digio.TRIG_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID;trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].stimulus", - "webhelpfile": "17688.htm", - "signature": "", - "command_return": "eventID", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which event starts the timer.", - "details": "The eventID parameter may be one of the trigger event IDs shown in the following table.Set this attribute to the eventID of any trigger event to cause the timer to start when that event\u00a0occurs.Set this attribute to zero (0) to disable event\u00a0processing.", - "param_info": [ - { - "name": "eventID", - "description": "The event that triggers the timer delay", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "eventID = trigger.timer[N].stimulus", - "trigger.timer[N].stimulus = eventID" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].stimulus);", - "description": "Prints the event that starts a trigger 1 timer\u00a0action.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "digio.trigger[N].pulsewidth", - "webhelpfile": "17691.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0\u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (seconds)", - "enum": "", - "type": "number", - "range": "(seconds)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "width = digio.trigger[N].pulsewidth", - "digio.trigger[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u03bcs.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].release()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "digio.trigger[N].reset()", - "webhelpfile": "17719.htm", - "signature": "digio.trigger[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger values to their factory defaults. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "This function resets the following attributes to factory default settings:It also clears digio.trigger[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "number", - "range": "(1 to 14)" - } - ], - "usage": [ - "digio.trigger[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].mode = 2;digio.trigger[3].pulsewidth = 50e-6;digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID;print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);digio.trigger[3].reset();print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus);", - "description": "Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 \u00b5s.\n--- --Use digital I/O line 5 to trigger the event on line 3.\n--- --Reset the line back to factory default values.\n--- --Output before reset:\n--- --2.00000e+00 5.00000e-05 5.00000e+00\n--- --Output after reset:\n--- --0.00000e+00 1.00000e-05 0.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].mode", - "digio.trigger[N].overrun", - "digio.trigger[N].pulsewidth", - "digio.trigger[N].stimulus" - ] - }, - { - "name": "scriptVar.list()", - "webhelpfile": "17785.htm", - "signature": "scriptVar.list()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a script listing.", - "details": "This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript and endscript).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.list()" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"test7\");test7();test7.save();test7.list();", - "description": "The above example code creates a script named test7 that displays text on the front panel and lists the script with the following output:\n--- --loadscript test7\n--- --display.clear() display.settext(\"Hello from my test\")\n--- --endscript\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Load a script by sending commands over the remote interface", - "Retrieve source code one line at a time" - ] - }, - { - "name": "bufferVar.fillcount", - "webhelpfile": "18551.htm", - "signature": "bufferVar.fillcount", - "command_return": "fillCount", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill count.", - "details": "The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on.This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillCount", - "description": "The reading buffer fill count", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillCount = bufferVar.fillcount", - "bufferVar.fillcount = fillCount" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillcount = 50;", - "description": "Sets fill count of dedicated reading buffer\u00a01 to\u00a050.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "18552.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "0 (smuX.FILL_ONCE)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the reading buffer fill mode.", - "details": "When this attribute is set to smuX.FILL_ONCE, the reading buffer does not overwrite readings. If the buffer fills up, new readings are discarded. When this attribute is set to smuX.FILL_WINDOW, new readings are added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading overwrites the reading at index 1, the reading after that overwrites the reading at index 2, and so on. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "fillMode", - "description": "The reading buffer fill mode; set to one of the following", - "enum": "smua.FILL_ONCE nil|smua.FILL_WINDOW nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "smua.nvbuffer1.fillmode = smua.FILL_ONCE;", - "description": "Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillcount", - "Reading buffers" - ] - }, - { - "name": "smua.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smua.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smua.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smub.buffer.getstats()", - "webhelpfile": "18554.htm", - "signature": "smub.buffer.getstats(bufferVar)", - "command_return": "statistics", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the statistics for a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that is placed in the buffer.The SMU automatically updates reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten.The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned is not updated. To get fresh statistics, call this function again.The statistics parameter has the attributes described in the following table.If n equals zero (0), all other attributes are nil. If n equals 1, the stddev attribute is nil because the standard deviation of a sample size of 1 is undefined.The min and max entries each have the attributes defined in the following table.", - "param_info": [ - { - "name": "statistics", - "description": "The statistical data about the data in the reading buffer", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "statistics = smub.buffer.getstats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();smua.nvbuffer1.clear();smua.measure.count = 10;smua.measure.v(smua.nvbuffer1);stats = smua.buffer.getstats(smua.nvbuffer1);print(\"n= \"..stats.n);print(\"mean= \"..stats.mean);print(\"stddev= \"..stats.stddev);print(\"min= \"..stats.min.reading);print(\"max= \"..stats.max.reading);", - "description": "Make measurements and store them in nvbuffer1. Print the statistics for the data.\n--- --Example output:\n--- --n= 10\n--- --mean= -2.3851394871599e-05\n--- --stddev= 4.406545187484e-07\n--- --min= -2.4557113647461e-05\n--- --max= -2.322196996829e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "smuX.buffer.recalculatestats()" - ] - }, - { - "name": "smua.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smua.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smua.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "smub.buffer.recalculatestats()", - "webhelpfile": "18556.htm", - "signature": "smub.buffer.recalculatestats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalculates the statistics of the specified reading buffer.", - "details": "This function causes the SMU to regenerate the reading buffer statistics about the specified reading buffer. Because the SMU automatically updates reading buffer statistics when data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics include the data that was overwritten. Use this function to recalculate the statistics that include only the data that is presently stored in the buffer.", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "bufferVar", - "description": "The reading buffer to process", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "smub.buffer.recalculatestats(bufferVar)" - ], - "overloads": [], - "examples": [ - { - "example": "smua.buffer.recalculatestats(smua.nvbuffer1);", - "description": "Recalculates the statistics of buffer smua.nvbuffer1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.fillmode", - "smuX.buffer.getstats()" - ] - }, - { - "name": "script.newautorun()", - "webhelpfile": "18832.htm", - "signature": "script.newautorun(code, name)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script and enables autorun.", - "details": "The name parameter is the name that is added to the script.user.scripts table. If name is not provided, an empty string is used, and the script is unnamed. If the name already exists in script.user.scripts, the name attribute of the existing script is set to an empty string before it is replaced by the new script.Note that name is the value that is used for the instrument front\u2011panel display. If this value is not defined, the script is not available from the front panel.You must save the new script into nonvolatile memory to keep it when the instrument is turned off.The script is run automatically immediately after it is created.This command is the same as the script.new() function except that the script is automatically run.", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "scriptVar", - "range": "" - }, - { - "name": "code", - "description": "A string that contains the body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "name", - "description": "The name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar = script.newautorun(code)", - "scriptVar = script.newautorun(code, name)" - ], - "overloads": [ - "scriptVar = script.newautorun(code)" - ], - "examples": [ - { - "example": "NewAuto = script.newautorun(\"print('Hello from new auto run command')\", 'NewAuto');print(NewAuto.autorun);print(NewAuto.name);", - "description": "Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name is set to NewAuto.\n--- --Output:\n--- --Hello from new auto run command\n--- --yes\n--- --NewAuto\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Create a script using the script.new() command", - "Global variables and the script.user.scripts table", - "Named scripts", - "script.new()", - "scriptVar.autorun", - "scriptVar.save()" - ] - }, - { - "name": "script.run()", - "webhelpfile": "18833.htm", - "signature": "script.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs the anonymous script.", - "details": "Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ", - "param_info": [ - { - "name": "run()", - "description": "Runs the anonymous script.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "script.run()", - "run()" - ], - "overloads": [], - "examples": [ - { - "example": "run();", - "description": "Runs the anonymous script.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "script.anonymous" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "18841.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the 2600B to provide an audible signal at a specified frequency and time duration. For example, you can use the beeper to signal the end of a lengthy sweep.The beeper does not sound if it is disabled. It can be disabled or enabled with the beeper enable command, or through the front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the tone in Hertz\u00a0(Hz)", - "enum": "", - "type": "number", - "range": "(Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.enable = beeper.ON;beeper.beep(2, 2400);", - "description": "Enables the beeper and generates a two\u2011second, 2400\u00a0Hz tone.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "beeper.enable" - ] - }, - { - "name": "SweepVListMeasureI()", - "webhelpfile": "19138.htm", - "signature": "SweepVListMeasureI(smuX, vlist, stime, points)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KISweep factory script function performs a voltage list sweep with current measured at every step\u00a0(point).", - "details": "Data for current measurements, voltage source values, and timestamps are stored in\u00a0smuX.nvbuffer1.If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.Performs a voltage list sweep with current measured at every step (point):", - "param_info": [ - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - }, - { - "name": "vlist", - "description": "Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "stime", - "description": "Settling time in seconds; occurs after stepping the source and before making a\u00a0measurement", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of sweep points (must be \u2265\u00a02)", - "enum": "", - "type": "number", - "range": "(must be \u2265\u00a02)" - } - ], - "usage": [ - "SweepVListMeasureI(smuX, vlist, stime, points)" - ], - "overloads": [], - "examples": [ - { - "example": "myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40, 40, 0, 0};SweepVListMeasureI(smua, myvlist, 500E-3, 10);", - "description": "This function performs a 10\u2011point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source is allowed to settle on each step for 500\u00a0ms before a measurement is performed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "KISweep factory script" - ] - }, - { - "name": "display.loadmenu.add()", - "webhelpfile": "19382.htm", - "signature": "display.loadmenu.add(displayName, code, memory)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the USER menu, which can be accessed by pressing the LOAD key on the front\u00a0panel.", - "details": "After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key then runs the\u00a0script.You can add items in any order. They are always displayed in alphabetical order when the menu is\u00a0selected.Any Lua code can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it is lost when the 2600B is turned off. See Example 2 below.If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.", - "param_info": [ - { - "name": "displayName", - "description": "The name that is added to the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "code", - "description": "The code that is run from the USER menu", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "memory", - "description": "Determines if code is saved to nonvolatile memory", - "enum": "display.DONT_SAVE nil|display.SAVE nil", - "type": "display", - "range": "" - } - ], - "usage": [ - "display.loadmenu.add(displayName, code)", - "display.loadmenu.add(displayName, code, memory)" - ], - "overloads": [ - "display.loadmenu.add(displayName, code)" - ], - "examples": [ - { - "example": "display.loadmenu.add(\"Test9\", \"Test9()\");", - "description": "Assume a user script named Test9 is loaded into the runtime environment. Adds the menu entry to the USER menu to run the script after loading.\n" - }, - { - "example": "display.loadmenu.add(\"Test\", \"DUT1() beeper.beep(2, 500)\", display.SAVE);", - "description": "Assume a script with a function named \u201cDUT1\u201d is loaded into the instrument, and the script has not been saved in nonvolatile memory.\n--- --Now assume you want to add a test named \u201cTest\u201d to the USER menu. You want the test to run the function named DUT1 and sound the beeper. This example adds Test to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.\n--- --When Test is run from the front panel USER menu, the function named DUT1 executes and the beeper beeps for two seconds.\n--- --Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named DUT1 is lost when you turn the instrument on. When Test is run again from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.\n" - }, - { - "example": "display.loadmenu.add(\"Part1\", \"testpart([[Part1]], 5.0)\", display.SAVE);", - "description": "Adds an entry called Part1 to the front\u2011panel USER load menu for the code testpart([[Part1]], 5.0) and saves it in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.loadmenu.delete()" - ] - }, - { - "name": "smua.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smua.OUTPUT_DCAMPS nil|smua.OUTPUT_DCVOLTS nil", - "type": "smuasourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smua.source.offfunc", - "smua.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "smub.source.offfunc", - "webhelpfile": "19504.htm", - "signature": "", - "command_return": "offfunc", - "type": "Attribute (RW)", - "default_value": "1 (smuX.OUTPUT_DCVOLTS)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the source function that is used (source 0 A or 0\u00a0V) when the output is turned off and the source\u2011measure unit (SMU) is in normal output-off mode.", - "details": "This attribute controls the source function used when the output is turned off and smuX.source.offmode is set to smuX.OUTPUT_NORMAL.Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0\u00a0V source when the output is off (smuX.source.offlimiti is used).Set it to smuX.OUTPUT_DCAMPS for the source to be a 0\u00a0A source when the output is off (smuX.source.offlimitv is used).", - "param_info": [ - { - "name": "offfunc", - "description": "Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values", - "enum": "smub.OUTPUT_DCAMPS nil|smub.OUTPUT_DCVOLTS nil", - "type": "smubsourceofffuncofffunc", - "range": "" - }, - { - "name": "X", - "description": "SMU channel (for example, smua.source.offfunc applies to SMU channel\u00a0A)", - "enum": "", - "type": "any", - "range": "(for example, smua.source.offfunc applies to SMU channel\u00a0A)" - } - ], - "usage": [ - "offfunc = smub.source.offfunc", - "smub.source.offfunc = offfunc" - ], - "overloads": [], - "examples": [ - { - "example": "smua.source.offmode = smua.OUTPUT_NORMAL;smua.source.offfunc = smua.OUTPUT_DCVOLTS;", - "description": "Sets the normal output-off mode to source 0\u00a0V when the output is turned off for SMU channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Output-off states", - "smuX.source.offlimitY", - "smuX.source.offmode", - "smuX.source.output" - ] - }, - { - "name": "bufferVar.measurefunctions", - "webhelpfile": "19914.htm", - "signature": "bufferVar.measurefunctions[N]", - "command_return": "measurefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement function that was used to acquire a reading stored in a specified reading\u00a0buffer.", - "details": "The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurefunction", - "description": "The measurement function used (Current, Voltage, Ohms, or Watts) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current, Voltage, Ohms, or Watts)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurefunction = bufferVar.measurefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurefunction = smua.nvbuffer1.measurefunctions[5];", - "description": "Store the measure function used to make reading number\u00a05.\n" - }, - { - "example": "printbuffer(1, 5, smua.nvbuffer1.measurefunctions);", - "description": "Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer\u00a01.\n--- --Example output:\n--- --Current, Current, Current, Current, Current\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.measureranges", - "webhelpfile": "19915.htm", - "signature": "bufferVar.measureranges[N]", - "command_return": "measurerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement range values that were used for readings stored in a specified buffer.", - "details": "The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "measurerange", - "description": "The measurement range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "any", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "measurerange = bufferVar.measureranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "measurerange = smua.nvbuffer1.measureranges[1];", - "description": "Store the measure range that was used to make reading number 1.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.measureranges);", - "description": "Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.\n--- --Example output:\n--- --1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07,1.00000e-07, 1.00000e-07\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcefunctions", - "webhelpfile": "19916.htm", - "signature": "bufferVar.sourcefunctions[N]", - "command_return": "sourcefunction", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source function that was being used when the readings were stored in a specified reading buffer.", - "details": "The bufferVar.sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcefunction", - "description": "The source function used (Current or Voltage) to acquire reading number N in the specified buffer", - "enum": "", - "type": "string[]", - "range": "(Current or Voltage)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcefunction = bufferVar.sourcefunctions[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcefunction = smua.nvbuffer1.sourcefunctions[3];print(sourcefunction);", - "description": "Store the source function used to make reading number\u00a03 and output the value.\n" - }, - { - "example": "printbuffer(1, 10, smua.nvbuffer1.sourcefunctions);", - "description": "Print the source function used for 10 readings stored in dedicated reading buffer 1.\n--- --Example output:\n--- --Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceoutputstates", - "webhelpfile": "19917.htm", - "signature": "bufferVar.sourceoutputstates[N]", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the state of the source output for readings that are stored in a specified buffer.", - "details": "The bufferVar.sourceoutputstates buffer recall attribute is similar to an array (a Lua table) of strings. This array indicates the state of the source output (Off or On) at the time of the measurement.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "state", - "description": "The output state (Off or On) when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "string[]", - "range": "(Off or On)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "state = bufferVar.sourceoutputstates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates);", - "description": "Print the source output for the first reading stored in dedicated reading buffer 1.\n--- --Example output:\n--- --On\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourceranges", - "webhelpfile": "19918.htm", - "signature": "bufferVar.sourceranges[N]", - "command_return": "sourcerange", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source range that was used for readings stored in a specified reading buffer.", - "details": "The bufferVar.sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcerange", - "description": "The source range used to acquire reading number N in the specified buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined), or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcerange = bufferVar.sourceranges[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcerange = smua.nvbuffer1.sourceranges[1];", - "description": "Store the source range that was used for the first reading stored in dedicated reading buffer 1.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourceranges);", - "description": "Print the source ranges that were used for the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.sourcevalues", - "webhelpfile": "19919.htm", - "signature": "bufferVar.sourcevalues[N]", - "command_return": "sourcevalue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.", - "details": "If the bufferVar.collectsourcevalues attribute is enabled before readings are made, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "sourcevalue", - "description": "The output value of the source when reading N of the specified buffer was\u00a0acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated buffer (user\u2011defined) or a dedicated reading buffer (such as smua.nvbuffer1)", - "enum": "", - "type": "bufferVar", - "range": "(user\u2011defined)" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "sourcevalue = bufferVar.sourcevalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "sourcevalue = smua.nvbuffer1.sourcevalues[1];\u00a0;", - "description": "Get the sourced value of the first reading stored in dedicated reading buffer\u00a01.\n" - }, - { - "example": "printbuffer(1, 6, smua.nvbuffer1.sourcevalues);", - "description": "Print the sourced value of the first 6 readings stored in source\u2011measure unit (SMU) A, buffer\u00a01.\n--- --Example output:\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04,\n--- --1.00000e-04, 1.00000e-04\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.collectsourcevalues", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "19920.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "The bufferVar.readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "print(smua.nvbuffer1.readings[1]);", - "description": "Output the first reading saved in source\u2011measure unit (SMU) channel A, dedicated reading buffer 1.\n--- --Output:\n--- --8.81658e-08\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "19921.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This read\u2011only buffer recall attribute is like an array (a Lua table) of the status values for all the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for\u00a0values. For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;smua.source.func = smua.OUTPUT_DCVOLTS;smua.source.autorangev = smua.AUTORANGE_ON;smua.source.levelv = 5 ;smua.source.limiti = 10e-3;smua.measure.rangei = 10e-3;smua.source.output = smua.OUTPUT_ON;print(smua.measure.i(smua.nvbuffer1));smua.source.output = smua.OUTPUT_OFF;\u00a0;print(smua.nvbuffer1.statuses[1]);", - "description": "Reset the instrument.\n--- --Set the voltage source function to dc volts. Set the range to auto.\n--- --Set the voltage source to 5\u00a0V.\n--- --Set current measure limit to 10 mA.\n--- --Set the current measure range to 10 mA.\n--- --Turn on the output.\n--- --Print and place the current reading in the reading buffer.\n--- --Turn off the output.\n--- --Output status value of the first measurement in the reading buffer. \n--- --Output example:\n--- --3.99470e-06\n--- --4.00000e+00\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.timestamps", - "Reading buffers" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "19922.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you cannot access any time information from a reading buffer. If enabled, this buffer recall attribute is like an array (a Lua table) that contains timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer.For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.", - "param_info": [ - { - "name": "timestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "number[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "N", - "description": "The reading number (1 to bufferVar.n)", - "enum": "", - "type": "any", - "range": "(1 to bufferVar.n)" - } - ], - "usage": [ - "timestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "timestamp = smua.nvbuffer1.timestamps[1];\u00a0;", - "description": "Get the timestamp of the first reading stored in source\u2011measure unit (SMU) A, buffer 1.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.clear()", - "bufferVar.collecttimestamps", - "bufferVar.measurefunctions", - "bufferVar.measureranges", - "bufferVar.n", - "bufferVar.readings", - "bufferVar.sourcefunctions", - "bufferVar.sourceoutputstates", - "bufferVar.sourceranges", - "bufferVar.sourcevalues", - "bufferVar.statuses", - "Reading buffers" - ] - }, - { - "name": "os.remove()", - "webhelpfile": "19929.htm", - "signature": "os.remove(filename)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes the file or directory with a given name.", - "details": "Directories must be empty before using the os.remove() function to delete them.If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string|nil", - "range": "(nil or an error message)" - }, - { - "name": "filename", - "description": "A string representing the name of the file or directory to delete", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.remove(filename)" - ], - "overloads": [], - "examples": [ - { - "example": "os.remove(\"testFile\");", - "description": "Delete the file named testFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.rename()" - ] - }, - { - "name": "os.rename()", - "webhelpfile": "19930.htm", - "signature": "os.rename(oldname, newname)", - "command_return": "success, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function renames an existing file or directory.", - "details": "If this function fails, it returns nil (for success) and an error message string (for msg).", - "param_info": [ - { - "name": "success", - "description": "A success indicator (true or nil)", - "enum": "", - "type": "boolean|nil", - "range": "(true or nil)" - }, - { - "name": "msg", - "description": "A message value (nil or an error message)", - "enum": "", - "type": "string", - "range": "(nil or an error message)" - }, - { - "name": "oldname", - "description": "String representing the name of the file or directory to rename", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newname", - "description": "String representing the new name of the file or directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "success, msg = os.rename(oldname, newname)" - ], - "overloads": [], - "examples": [ - { - "example": "os.rename(\"testFile\", \"exampleFile\");\u00a0;", - "description": "Changes the name of the existing file testFile to the name exampleFile.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "os.remove()" - ] - }, - { - "name": "script.factory.catalog()", - "webhelpfile": "19931.htm", - "signature": "for name in script.factory.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.", - "details": "Accessing this catalog of scripts allows you to process the factory scripts. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the names in the\u00a0catalog", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in script.factory.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.factory.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for factory scripts.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.smua.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmualimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smua.limit.func", - "display.smua.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.smub.limit.func", - "webhelpfile": "20584.htm", - "signature": "", - "command_return": "func", - "type": "Attribute (RW)", - "default_value": "0 (display.LIMIT_IV)\n", - "tsp_link": "Yes\n", - "description": "If you are using a display mode that shows a single channel, this attribute specifies the type of limit value setting displayed.", - "details": "Selects the displayed limit function: primary (IV) or power (P).SMU A and SMU B can be set for different display functions.", - "param_info": [ - { - "name": "func", - "description": "One of the following values", - "enum": "display.LIMIT_IV nil|display.LIMIT_P nil", - "type": "displaysmublimitfuncfunc", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "func = display.smub.limit.func", - "display.smub.limit.func = func" - ], - "overloads": [], - "examples": [ - { - "example": "display.smua.limit.func = display.LIMIT_P;", - "description": "Specifies the power limit value is displayed for SMU Channel A.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "display.smuX.measure.func", - "\u201cDisplay mode\u201d in the Series 2600B User's Manual" - ] - }, - { - "name": "display.waitkey()", - "webhelpfile": "20642.htm", - "signature": "display.waitkey()", - "command_return": "keyCode", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function captures the key code value for the next front\u2011panel action.", - "details": "After you send this function, script execution pauses until a front\u2011panel action (for example, pressing a key or the navigation wheel, or turning the navigation wheel). After the action, the value of the key (or action) is returned.If the EXIT (LOCAL) key is pressed while this function is waiting for a front\u2011panel action, the script is not aborted.A typical use for this function is to prompt the user to press the EXIT (LOCAL) key to abort the script or press any other key to continue. For example, if the keyCode value 75 is returned (the EXIT (LOCAL) key was pressed), you can call the exit() function to abort the script.The table below lists the keyCode values for each front panel action.", - "param_info": [ - { - "name": "keyCode", - "description": "See Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "keyCode = display.waitkey()" - ], - "overloads": [], - "examples": [ - { - "example": "key = display.waitkey();print(key);", - "description": "Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.\n--- --If the output is:\n--- --8.60000e+01\n--- --It indicates that the MEAS(A) key was pressed.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Capturing key-press codes", - "display.getlastkey()", - "display.sendkey()", - "display.settext()" - ] - }, - { - "name": "scriptVar.name", - "webhelpfile": "2589.htm", - "signature": "", - "command_return": "scriptName", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute contains the name of a script in the runtime environment.", - "details": "When setting the script name, this attribute renames the script that the variable scriptVar references.This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index that is used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script is removed from the runtime environment.If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ", - "param_info": [ - { - "name": "scriptVar", - "description": "Name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.name = scriptName", - "scriptName = scriptVar.name" - ], - "overloads": [], - "examples": [ - { - "example": "test7 = script.new(\"display.clear() display.settext('Hello\u00a0from\u00a0my\u00a0test')\", \"\");test7();print(test7.name);\u00a0;test7.name = \"test7\";print(test7.name);test7.save();", - "description": "This example calls the script.new() function to create a script with no name, runs the script, names the script test7, and then saves the script in nonvolatile memory.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Rename a script", - "script.new()", - "scriptVar.save()" - ] - }, - { - "name": "os.time()", - "webhelpfile": "25959.htm", - "signature": "os.time(timespec)", - "command_return": "utcTime", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a time value in UTC time.", - "details": "The timespec is a table using the fields listed in the table below.If the time (hour, minute, and second) options are not used, they default to noon for that day. When called without a parameter (the first form), the function returns the current time.Set the time zone before calling the os.time() function.", - "param_info": [ - { - "name": "utcTime", - "description": "Time value in UTC time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timespec", - "description": "The date and time (year, month, day, hour, and minute)", - "enum": "", - "type": "table", - "range": "(year, month, day, hour, and minute)" - } - ], - "usage": [ - "utcTime = os.time()", - "utcTime = os.time(timespec)" - ], - "overloads": [ - "utcTime = os.time()" - ], - "examples": [ - { - "example": "systemTime = os.time({year = 2019,; month = 3,; day = 31,; hour = 14,; min = 25});settime(systemTime);", - "description": "Sets the date and time to Mar 31, 2019 at\u00a02:25\u00a0pm.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "settime()", - "settimezone()" - ] - }, - { - "name": "digio.trigger[N].stimulus", - "webhelpfile": "26898.htm", - "signature": "", - "command_return": "triggerStimulus", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Set this attribute to zero (0) to disable the automatic trigger output.Do not use this attribute to generate output triggers under script control. Use digio.trigger[N].assert()\u00a0instead.The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs described in the following table.", - "param_info": [ - { - "name": "triggerStimulus", - "description": "The event identifier for the triggering event", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 14)", - "enum": "", - "type": "any", - "range": "(1 to 14)" - } - ], - "usage": [ - "triggerStimulus = digio.trigger[N].stimulus", - "digio.trigger[N].stimulus = triggerStimulus" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[3].stimulus = 0;", - "description": "Clear the trigger stimulus of digital I/O line 3.\n" - }, - { - "example": "digio.trigger[3].stimulus = smua.trigger.SOURCE_COMPLETE_EVENT_ID;", - "description": "Set the trigger stimulus of digital I/O line 3 to be the source complete event.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].clear()", - "digio.trigger[N].reset()" - ] - }, - { - "name": "status.measurement.condition", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.enable", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.event", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ntr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.ptr", - "webhelpfile": "27145.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event register set.", - "details": "These attributes read or write the measurement event registers.Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are\u00a0set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV. In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.condition", - "measurementRegister = status.measurement.enable", - "measurementRegister = status.measurement.event", - "measurementRegister = status.measurement.ntr", - "measurementRegister = status.measurement.ptr", - "status.measurement.enable = measurementRegister", - "status.measurement.ntr = measurementRegister", - "status.measurement.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.enable = status.measurement.BAV;", - "description": "Sets the BAV bit of the measurement event enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.condition", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.enable", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.event", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ntr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.buffer_available.ptr", - "webhelpfile": "27146.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event buffer available summary register set.", - "details": "These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.buffer_available.condition", - "measurementRegister = status.measurement.buffer_available.enable", - "measurementRegister = status.measurement.buffer_available.event", - "measurementRegister = status.measurement.buffer_available.ntr", - "measurementRegister = status.measurement.buffer_available.ptr", - "status.measurement.buffer_available.enable = measurementRegister", - "status.measurement.buffer_available.ntr = measurementRegister", - "status.measurement.buffer_available.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA;", - "description": "Sets the SMUA bit of the measurement event buffer available summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.current_limit.condition", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.enable", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.event", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ntr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.current_limit.ptr", - "webhelpfile": "27165.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event current limit summary registers.", - "details": "These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For example, assume value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are\u00a0set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event current limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.current_limit.condition", - "measurementRegister = status.measurement.current_limit.enable", - "measurementRegister = status.measurement.current_limit.event", - "measurementRegister = status.measurement.current_limit.ntr", - "measurementRegister = status.measurement.current_limit.ptr", - "status.measurement.current_limit.enable = measurementRegister", - "status.measurement.current_limit.ntr = measurementRegister", - "status.measurement.current_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.current_limit.enable = status.measurement.current_limit.SMUA;", - "description": "Sets the SMUA bit of the Measurement Event Current Limit Summary Enable Register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers", - "status.measurement.instrument.smuX.*" - ] - }, - { - "name": "status.measurement.instrument.condition", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.enable", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.event", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ntr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.ptr", - "webhelpfile": "27167.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event instrument summary register set.", - "details": "These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 6 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00110. This value indicates that bit B1 (SMUA) and bit B2 (SMUB) are set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement event instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.condition", - "measurementRegister = status.measurement.instrument.enable", - "measurementRegister = status.measurement.instrument.event", - "measurementRegister = status.measurement.instrument.ntr", - "measurementRegister = status.measurement.instrument.ptr", - "status.measurement.instrument.enable = measurementRegister", - "status.measurement.instrument.ntr = measurementRegister", - "status.measurement.instrument.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.enable = status.measurement.instrument.SMUA;", - "description": "Sets the SMU A bit of the measurement event instrument summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.condition", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.enable", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.event", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ntr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.reading_overflow.ptr", - "webhelpfile": "27169.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event reading overflow summary register set. ", - "details": "These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000\u00a00000\u00a00000\u00a00010. This value indicates that bit B1 (SMUA) is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement reading overflow summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.reading_overflow.condition", - "measurementRegister = status.measurement.reading_overflow.enable", - "measurementRegister = status.measurement.reading_overflow.event", - "measurementRegister = status.measurement.reading_overflow.ntr", - "measurementRegister = status.measurement.reading_overflow.ptr", - "status.measurement.reading_overflow.enable = measurementRegister", - "status.measurement.reading_overflow.ntr = measurementRegister", - "status.measurement.reading_overflow.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA;", - "description": "Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.operation.calibrating.condition", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.enable", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.event", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ntr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.calibrating.ptr", - "webhelpfile": "27170.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status calibration summary register set. ", - "details": "These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. ", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation calibrating event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.calibrating.condition", - "operationRegister = status.operation.calibrating.enable", - "operationRegister = status.operation.calibrating.event", - "operationRegister = status.operation.calibrating.ntr", - "operationRegister = status.operation.calibrating.ptr", - "status.operation.calibrating.enable = operationRegister", - "status.operation.calibrating.ntr = operationRegister", - "status.operation.calibrating.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.calibrating.enable = status.operation.calibrating.SMUA;", - "description": "Sets the SMUA bit of the operation status calibration summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.instrument.condition", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.enable", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.event", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ntr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.instrument.ptr", - "webhelpfile": "27207.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status instrument summary register set. ", - "details": "These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024). Condition register sets of:", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation event register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.instrument.condition", - "operationRegister = status.operation.instrument.enable", - "operationRegister = status.operation.instrument.event", - "operationRegister = status.operation.instrument.ntr", - "operationRegister = status.operation.instrument.ptr", - "status.operation.instrument.enable = operationRegister", - "status.operation.instrument.ntr = operationRegister", - "status.operation.instrument.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.instrument.SMUA +; status.operation.instrument.TRGBLND;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.\n" - }, - { - "example": "-- 1026 = binary 0000 0100 0000 0010;operationRegister = 1026;status.operation.instrument.enable = operationRegister;", - "description": "Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*", - "\u2022 status.operation.instrument.digio.*", - "\u2022 status.operation.instrument.lan.*", - "\u2022 status.operation.instrument.trigger_blender.*", - "\u2022 status.operation.instrument.trigger_timer.*", - "\u2022 status.operation.instrument.tsplink.*" - ] - }, - { - "name": "status.operation.measuring.condition", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.enable", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.event", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ntr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.measuring.ptr", - "webhelpfile": "27208.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status measuring summary register set. ", - "details": "These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the operation status measuring summary enable register, set status.operation.measuring.enable\u00a0=\u00a0status.operation.measuring.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status measuring summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.measuring.condition", - "operationRegister = status.operation.measuring.enable", - "operationRegister = status.operation.measuring.event", - "operationRegister = status.operation.measuring.ntr", - "operationRegister = status.operation.measuring.ptr", - "status.operation.measuring.enable = operationRegister", - "status.operation.measuring.ntr = operationRegister", - "status.operation.measuring.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.measuring.enable = status.operation.measuring.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status measuring summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.condition", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.enable", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.event", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ntr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.sweeping.ptr", - "webhelpfile": "27209.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status sweeping summary register set. ", - "details": "These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status sweeping summary enable register, set status.operation.sweeping.enable\u00a0=\u00a0status.operation.sweeping.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set operationRegister to 6 (the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status sweeping summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.sweeping.condition", - "operationRegister = status.operation.sweeping.enable", - "operationRegister = status.operation.sweeping.event", - "operationRegister = status.operation.sweeping.ntr", - "operationRegister = status.operation.sweeping.ptr", - "status.operation.sweeping.enable = operationRegister", - "status.operation.sweeping.ntr = operationRegister", - "status.operation.sweeping.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.sweeping.enable = status.operation.sweeping.SMUA;", - "description": "Uses a constant to set the SMUA bit of the operation status sweeping summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.condition", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.enable", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.event", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ntr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.operation.trigger_overrun.ptr", - "webhelpfile": "27210.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger overrun summary register set. ", - "details": "These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1,026) is read as the value of the condition register, the binary equivalent is 0000\u00a00100\u00a00000\u00a00010. This value indicates that bit B1 and bit B10 are set.* Least significant bit** Most significant bitThe bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1,024).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger overrun summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.trigger_overrun.condition", - "operationRegister = status.operation.trigger_overrun.enable", - "operationRegister = status.operation.trigger_overrun.event", - "operationRegister = status.operation.trigger_overrun.ntr", - "operationRegister = status.operation.trigger_overrun.ptr", - "status.operation.trigger_overrun.enable = operationRegister", - "status.operation.trigger_overrun.ntr = operationRegister", - "status.operation.trigger_overrun.ptr = operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "operationRegister = status.operation.trigger_overrun.SMUA + status.operation.trigger_overrun.TRGBLND;status.operation.trigger_overrun.enable = operationRegister;", - "description": "Uses constants to set bit B1 and bit B10 of the operation status trigger overrun summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.*" - ] - }, - { - "name": "status.questionable.calibration.condition", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.enable", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.event", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ntr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.calibration.ptr", - "webhelpfile": "27211.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status calibration summary register set. ", - "details": "These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table. As an example, to set bit B1 of the questionable status calibration summary enable register, set status.questionable.calibration.enable = status.questionable.calibration.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2\u00a0+\u00a04).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status calibration summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.calibration.condition", - "questionableRegister = status.questionable.calibration.enable", - "questionableRegister = status.questionable.calibration.event", - "questionableRegister = status.questionable.calibration.ntr", - "questionableRegister = status.questionable.calibration.ptr", - "status.questionable.calibration.enable = questionableRegister", - "status.questionable.calibration.ntr = questionableRegister", - "status.questionable.calibration.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.calibration.enable = status.questionable.calibration.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status calibration summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.condition", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.enable", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.event", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ntr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.instrument.ptr", - "webhelpfile": "27212.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status instrument summary register set. ", - "details": "These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status instrument summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status instrument summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.instrument.condition", - "questionableRegister = status.questionable.instrument.enable", - "questionableRegister = status.questionable.instrument.event", - "questionableRegister = status.questionable.instrument.ntr", - "questionableRegister = status.questionable.instrument.ptr", - "status.questionable.instrument.enable = questionableRegister", - "status.questionable.instrument.ntr = questionableRegister", - "status.questionable.instrument.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.instrument.enable = status.questionable.instrument.SMUA;", - "description": "Uses a constant to set the SMUA bit of the questionable status instrument summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.condition", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.enable", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.event", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ntr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.questionable.over_temperature.ptr", - "webhelpfile": "27213.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the questionable status over temperature summary register set. ", - "details": "These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the questionable status over temperature summary enable register, set status.questionable.instrument.enable = status.questionable.instrument.SMUA.In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set questionableRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The status of the questionable status over temperature summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "questionableRegister = status.questionable.over_temperature.condition", - "questionableRegister = status.questionable.over_temperature.enable", - "questionableRegister = status.questionable.over_temperature.event", - "questionableRegister = status.questionable.over_temperature.ntr", - "questionableRegister = status.questionable.over_temperature.ptr", - "status.questionable.over_temperature.enable = questionableRegister", - "status.questionable.over_temperature.ntr = questionableRegister", - "status.questionable.over_temperature.ptr = questionableRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.over_temperature.enable = status.questionable.over_temperature.SMUA;", - "description": "Uses a constant to set the SMU A bit in the questionable status over temperature summary enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Questionable Status Registers", - "status.questionable.*" - ] - }, - { - "name": "status.measurement.voltage_limit.condition", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.enable", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.event", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ntr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.voltage_limit.ptr", - "webhelpfile": "27887.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the measurement event voltage limit summary register set. ", - "details": "These attributes read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B2, set measurementRegister to 6 (which is the sum of 2 + 4).", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the measurement voltage limit summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other decimal values indicate various bit settings ", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "measurementRegister = status.measurement.voltage_limit.condition", - "measurementRegister = status.measurement.voltage_limit.enable", - "measurementRegister = status.measurement.voltage_limit.event", - "measurementRegister = status.measurement.voltage_limit.ntr", - "measurementRegister = status.measurement.voltage_limit.ptr", - "status.measurement.voltage_limit.enable = measurementRegister", - "status.measurement.voltage_limit.ntr = measurementRegister", - "status.measurement.voltage_limit.ptr = measurementRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA;", - "description": "Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smua.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.condition", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.enable", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.event", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ntr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "status.measurement.instrument.smub.ptr", - "webhelpfile": "28238.htm", - "signature": "", - "command_return": "measurementRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the registers of the measurement event SMU X summary register set.", - "details": "These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000\u00a00001\u00a00000\u00a00001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.* Least significant bit** Most significant bitFor information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ", - "param_info": [ - { - "name": "measurementRegister", - "description": "The status of the instrument measurement status SMU X summary register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - }, - { - "name": "X", - "description": "Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)", - "enum": "", - "type": "number", - "range": "(SMU)" - } - ], - "usage": [ - "measurementRegister = status.measurement.instrument.smuX.condition", - "measurementRegister = status.measurement.instrument.smuX.enable", - "measurementRegister = status.measurement.instrument.smuX.event", - "measurementRegister = status.measurement.instrument.smuX.ntr", - "measurementRegister = status.measurement.instrument.smuX.ptr", - "status.measurement.instrument.smuX.enable = measurementRegister", - "status.measurement.instrument.smuX.ntr = measurementRegister", - "status.measurement.instrument.smuX.ptr = measurementRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT;", - "description": "Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Measurement event registers" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "29213.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts from a remote node. This command is not available on the 2604B, 2614B, or 2634B.", - "details": "Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node; only on this node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.This command should only be used from a remote master when controlling this instrument over a TSP-Link\u00ae.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x\u00a0=\u00a05\") to set x\n--- --equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "TSP advanced features", - "tsplink.group" - ] - }, - { - "name": "trigger.generator[N].assert()", - "webhelpfile": "29218.htm", - "signature": "trigger.generator[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates a trigger event.", - "details": "Use this function to directly trigger events from the command interface or a script. For example, you can trigger a sweep while the instrument is under script control.", - "param_info": [ - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "trigger.generator[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.generator[2].assert();", - "description": "Generates a trigger event on generator 2.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].EVENT_ID" - ] - }, - { - "name": "trigger.generator[N].EVENT_ID", - "webhelpfile": "29219.htm", - "signature": "", - "command_return": "eventID", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant identifies the trigger event generated by the trigger event generator.", - "details": "This constant is an identification number that identifies events generated by this generator.To have another trigger object respond to trigger events generated by this generator, set the other object's stimulus attribute to the value of this constant.", - "param_info": [ - { - "name": "eventID", - "description": "The trigger event number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The generator number (1 or 2)", - "enum": "", - "type": "any", - "range": "(1 or 2)" - } - ], - "usage": [ - "eventID = trigger.generator[N].EVENT_ID" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[5].stimulus = trigger.generator[2].EVENT_ID;", - "description": "Uses a trigger event on generator 2 to be the stimulus for digital I/O trigger line 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "trigger.generator[N].assert()" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.condition", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.enable", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.event", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "webhelpfile": "29234.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "- -\n", - "tsp_link": "Yes", - "description": "This attribute contains the operation status trigger blender overrun register set.", - "details": "These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000\u00a00000\u00a00001\u00a00010. This value indicates that bit B1 and bit B4 are set.* Least significant bit** Most significant bitA set bit value indicates that the specified trigger blender generated an action overrun.For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status trigger blender overrun register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = ", - " status.operation.instrument.trigger_blender.trigger_overrun.condition", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.enable", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.event", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ntr", - "operationRegister =", - " status.operation.instrument.trigger_blender.trigger_overrun.ptr", - "status.operation.instrument.trigger_blender.trigger_overrun.enable =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ntr =", - " operationRegister", - "status.operation.instrument.trigger_blender.trigger_overrun.ptr =", - " operationRegister " - ], - "overloads": [], - "examples": [ - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable; = status.operation.instrument.trigger_blender.trigger_overrun.BLND1;", - "description": "Uses the constant to set the bit for blender 1 of the operation status trigger blender overrun enable register.\n" - }, - { - "example": "status.operation.instrument.trigger_blender.trigger_overrun.enable = 18;", - "description": "Uses the decimal value to set the bits for blenders 1 and 4 of the operation status trigger blender overrun enable register.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Operation Status Registers", - "status.operation.instrument.trigger_blender.*" - ] - }, - { - "name": "status.condition", - "webhelpfile": "29255.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000\u00a00001. This value indicates that bit B0 and bit B7 are set.* Least significant bit** Most significant bitThe returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.The individual bits of this register have the following meanings:In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte; a zero (0) indicates no bits set; other values indicate various bit\u00a0settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Sample output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Status byte and service request (SRQ)" - ] - }, - { - "name": "ConfigPulseIMeasureVSweepLog()", - "webhelpfile": "29313.htm", - "signature": "ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.The magnitude of the first pulse is start amperes; the magnitude of the last pulse is stop amperes. The magnitude of each pulse in between is LogStepn amperes larger than the previous pulse, where:LogStepSize = (log10(stop) - log10(start)) / (points -1)LogStepn = (n - 1) * (LogStepSize), where n = [2, points]SourceStepLeveln = antilog(LogStepn) * startThis function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2).", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "start", - "description": "Pulse sweep start level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "stop", - "description": "Pulse sweep stop level in amperes", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Voltage limit (for example, compliance) in volts", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseIMeasureVSweepLog(smua, 0, 1e-3, 0.01, 1, 1e-3, 10e-3, 10, smua.nvbuffer1, 5);", - "description": "Set up a pulsed logarithmic sweep that uses channel A. The pulsed sweep starts at 1\u00a0mA, ends at 10\u00a0mA, and returns to a 0\u00a0A bias level between pulses. Each pulsed step is on for 1\u00a0ms, and then at the bias level for 10 ms. The voltage limit is 1\u00a0V during the entire pulsed sweep. The pulse train is comprised of 10 pulsed steps, and the pulse train is assigned a tag index of 5.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "ConfigPulseVMeasureI()", - "webhelpfile": "29314.htm", - "signature": "ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "command_return": "f, msg", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.", - "details": "Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. This function does not cause the specified smu to output a pulse train. It does check to see if all the pulse dimensions can be achieved, and if they can, assigns the indicated tag or index to the pulse train. To initiate a pulse train assigned to a valid tag, use InitiatePulseTest(tag) and InitiatePulseTestDual(tag1, tag2) .", - "param_info": [ - { - "name": "f", - "description": "A Boolean flag; this flag is true when the pulse was successfully configured, false when errors were encountered ", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "msg", - "description": "A string message; if the f flag is false, msg contains an error message; if it is true, msg contains a string indicating successful configuration", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "smu", - "description": "Instrument channel (for example, smua refers to SMU channel A)", - "enum": "", - "type": "table", - "range": "(for example, smua refers to SMU channel A)" - }, - { - "name": "bias", - "description": "Bias level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "level", - "description": "Pulse level in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit", - "description": "Current limit (for example, compliance) in amperes", - "enum": "", - "type": "number", - "range": "(for example, compliance)" - }, - { - "name": "ton", - "description": "Pulse on time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "toff", - "description": "Pulse off time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "points", - "description": "Number of pulse-measure cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "buffer", - "description": "Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "tag", - "description": "Numeric identifier to be assigned to the defined pulse train", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in", - "description": "Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_out", - "description": "Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "sync_in_timeout", - "description": "Specifies the length of time (in seconds) to wait for input trigger; default value is 10\u00a0s", - "enum": "", - "type": "number", - "range": "(in seconds)" - }, - { - "name": "sync_in_abort", - "description": "Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or\u00a0false", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)" - ], - "overloads": [ - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out)", - "f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)" - ], - "examples": [ - { - "example": "ConfigPulseVMeasureI(smua, 0, 20, 1, 0.001, 0.080, 10, smua.nvbuffer1, 2);", - "description": "Set up a pulse train that uses channel A. The pulse amplitude is 20\u00a0V and returns to 0\u00a0V after 1\u00a0ms. The pulse remains at 0\u00a0V for 80 ms, and the current limit is 1\u00a0A during the pulse. The pulse train consists of 10 pulses, and the pulse train is assigned a tag index of 2.\n" - }, - { - "example": "local timelist = { 1, 2, 3, 4, 5 };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 1,; 100e-3, 1, timelist, 5, nil, 1);", - "description": "Variable off time between pulses in a pulse train.\n--- --Configure a pulse with 1 second on-time and variable off-time, no measurement.\n" - }, - { - "example": "rbi = smua.makebuffer(10);rbv = smua.makebuffer(10);rbi.appendmode = 1;rbv.appendmode = 1;rbs = { i = rbi, v = rbv };\u00a0;f, msg = ConfigPulseVMeasureI(smua, 0, 10, 1e-3, 1e-3, 1e-3, 2, rbs, 1);", - "description": "Simultaneous IV measurement during pulse.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "InitiatePulseTest()", - "InitiatePulseTestDual()", - "KIPulse factory script" - ] - }, - { - "name": "lan.config.dns.hostname", - "webhelpfile": "66559.htm", - "signature": "", - "command_return": "hostName", - "type": "Attribute (RW)", - "default_value": "Instrument specific (see Details)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the dynamic DNS host name.", - "details": "This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS\u00a0server.The factory default value for hostName is \"k\u2011\u2011\", where and are replaced with the actual model number and serial number of the instrument (for example, \"k\u20112602B\u20111234567\"). Note that hyphens separate the characters of hostName. The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 63 characters can be entered here, you must make sure the combined length is no more than 255 characters.Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero or a string that consists entirely of whitespace characters) reverts the host name to the factory default value.", - "param_info": [ - { - "name": "hostName", - "description": "The host name to use for dynamic DNS registration; the host name must", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "hostName = lan.config.dns.hostname", - "lan.config.dns.hostname = hostName" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.config.dns.hostname);", - "description": "Outputs the present dynamic DNS host name.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "lan.config.dns.domain", - "lan.config.dns.dynamic", - "lan.restoredefaults()" - ] - }, - { - "name": "io.input()", - "webhelpfile": "66560.htm", - "signature": "io.input(newfile)", - "command_return": "fileVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function assigns a previously opened file, or opens a new file, as the default input file.", - "details": "The newfile path may be absolute or relative to the current working directory.When using this function from a remote TSP-Link\u00ae node, this command does not accept a file descriptor and does not return a value.If the function fails, an error message is returned.", - "param_info": [ - { - "name": "fileVar", - "description": "The descriptor of the input file or an error message (if the function fails)", - "enum": "", - "type": "io_object", - "range": "(if the function fails)" - }, - { - "name": "newfile", - "description": "A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fileVar = io.input()", - "fileVar = io.input(newfile)" - ], - "overloads": [ - "fileVar = io.input()" - ], - "examples": [], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "io.open()", - "io.output()" - ] - }, - { - "name": "setup.recall()", - "webhelpfile": "66566.htm", - "signature": "setup.recall(id)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls settings from a saved setup.", - "details": "When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n\u00a0=\u00a00, the instrument recalls the factory default setup; when n\u00a0=\u00a01\u00a0to\u00a05, the instrument recalls a user-saved setup.When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.Before a setup is recalled, an instrument reset is performed.", - "param_info": [ - { - "name": "id", - "description": "An integer or string that specifies the location of the setup to recall", - "enum": "", - "type": "number|string", - "range": "" - } - ], - "usage": [ - "setup.recall(id)" - ], - "overloads": [], - "examples": [ - { - "example": "setup.recall(1);", - "description": "Recall the user-saved setup at location 1.\n" - }, - { - "example": "setup.recall(\"/usb1/KEITHLEY_30730.set\");", - "description": "Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash\u00a0drive.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "Saved setups", - "setup.save()" - ] - }, - { - "name": "smua.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smua.measure.count", - "smua.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "smub.measure.count", - "webhelpfile": "77107.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements made when a measurement is requested.", - "details": "This attribute controls the number of measurements made any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.If the count is set to a value greater than 1, any measurement delay set by smuX.measure.delay only occurs before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.", - "param_info": [ - { - "name": "count", - "description": "Number of measurements", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "X", - "description": "Source\u2011measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)", - "enum": "", - "type": "any", - "range": "(SMU)" - } - ], - "usage": [ - "count = smub.measure.count", - "smub.measure.count = count" - ], - "overloads": [], - "examples": [ - { - "example": "smua.measure.count = 10;", - "description": "Sets the SMU channel A measure count to 10.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "reset()", - "setup.recall()", - "smuX.measure.delay", - "smuX.measure.interval", - "smuX.measure.overlappedY()", - "smuX.measure.Y()", - "smuX.reset()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "80596.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex \u2264 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.When any given reading buffers are used in overlapped commands that have not yet completed (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the measurements have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data. The response message is stored in the output queue.The format.data attribute controls the format of the response message.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "First table or reading buffer subtable to print", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.data = format.ASCII;format.asciiprecision = 6;printbuffer(1, rb1.n, rb1);", - "description": "This assumes that rb1 is a valid reading buffer in the runtime environment. The use of rb1.n\n--- --(bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.\n--- --Example of output data (rb1.readings):\n--- --4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "localnode.license", - "webhelpfile": "92667.htm", - "signature": "", - "command_return": "license_agreement", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the product license agreements.", - "details": "", - "param_info": [ - { - "name": "license_agreement", - "description": "The text of the license agreements", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "license_agreement = localnode.license" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.license);", - "description": "Returns the license agreements for the 2600B.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "None" - ] - }, - { - "name": "display.sendkey()", - "webhelpfile": "98308.htm", - "signature": "display.sendkey(keyCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sends a code that simulates the action of a front\u2011panel control.", - "details": "This command simulates pressing a front\u2011panel key or navigation wheel, or turning the navigation wheel one click to the left or right.", - "param_info": [ - { - "name": "keyCode", - "description": "A parameter that specifies the key press to simulate; see Details for more information", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "display.sendkey(keyCode)" - ], - "overloads": [], - "examples": [ - { - "example": "display.sendkey(display.KEY_RUN);", - "description": "Simulates pressing the RUN key.\n" - } - ], - "supported_models": "2601, 2602, 2611, 2612, 2635, 2636, 2601A, 2602A, 2611A, 2612A, 2635A, 2636A,2651A, 2657A, 2601B, 2601B-PULSE, 2602B, 2606B, 2611B, 2612B, 2635B, 2636B, 2604B, 2614B, 2634B,2601B-L, 2602B-L, 2611B-L, 2612B-L, 2635B-L, 2636B-L, 2604B-L, 2614B-L, 2634B-L", - "related_commands": [ - "\u201cFront panel\u201d in the Series 2600B User's Manual" - ] - } - ] -} \ No newline at end of file diff --git a/data/DMM7510.json b/data/DMM7510.json deleted file mode 100644 index d0bc63f..0000000 --- a/data/DMM7510.json +++ /dev/null @@ -1,18114 +0,0 @@ -{ - "commands": [ - { - "name": "delay()", - "webhelpfile": "13949.htm", - "signature": "delay(seconds)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function delays the execution of the commands that follow it.", - "details": "The instrument delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the instrument to delay 5\u00a0\u03bcs to 10\u00a0\u03bcs (typical) more than the requested delay.", - "param_info": [ - { - "name": "seconds", - "description": "The number of seconds to delay (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - } - ], - "usage": [ - "delay(seconds)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(0.5, 2400);delay(0.250);beeper.beep(0.5, 2400);", - "description": "Emit a double-beep at 2400 Hz. The sequence is 0.5\u00a0s on, 0.25\u00a0s off, 0.5\u00a0s on.\n" - }, - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "waitcomplete()", - "webhelpfile": "13986.htm", - "signature": "waitcomplete(group)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for all previously started overlapped commands to complete.", - "details": "There are two types of instrument commands:The waitcomplete() command suspends the execution of commands until the instrument operations of all previous overlapped commands are finished. This command is not needed for sequential commands.A group number may only be specified when this node is the master node.If no group is specified, the local group is used.If zero (0) is specified for the group, this function waits for all nodes in the system.", - "param_info": [ - { - "name": "group", - "description": "Specifies which TSP-Link group on which to wait", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "waitcomplete()", - "waitcomplete(group)" - ], - "overloads": [ - "waitcomplete()" - ], - "examples": [ - { - "example": "waitcomplete();", - "description": "Waits for all nodes in the local group.\n" - }, - { - "example": "waitcomplete(G);", - "description": "Waits for all nodes in group G.\n" - }, - { - "example": "waitcomplete(0);", - "description": "Waits for all nodes on the TSP-Link network.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "userstring.add()", - "webhelpfile": "13987.htm", - "signature": "userstring.add(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function adds a user-defined string to nonvolatile memory.", - "details": "This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.Use the userstring.get() function to retrieve the value associated with the specified name.You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The string to associate with name; the value of the key-value pair", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "userstring.add(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Stores user-defined strings in nonvolatile memory and recalls them from the instrument using a for loop.\n--- --Example output:\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --product = Widgets\n" - } - ], - "related_commands": [ - "userstring.catalog()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.catalog()", - "webhelpfile": "13988.htm", - "signature": "for name in userstring.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates an iterator for the user-defined string catalog.", - "details": "The catalog provides access for user-defined string pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.", - "param_info": [ - { - "name": "name", - "description": "The name of the string; the key of the key-value pair", - "enum": "", - "type": "stirng", - "range": "" - }, - { - "name": "body", - "description": "Code to execute in the body of the for loop", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "for name in userstring.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in userstring.catalog() do; userstring.delete(name);end;", - "description": "Deletes all user-defined strings in nonvolatile memory.\n" - }, - { - "example": "userstring.add(\"assetnumber\", \"236\");userstring.add(\"product\", \"Widgets\");userstring.add(\"contact\", \"John Doe\");for name in userstring.catalog() do; print(name .. \" = \" ..; userstring.get(name));end;", - "description": "Prints all userstring key-value pairs.\n--- --Output:\n--- --product = Widgets\n--- --assetnumber = 236\n--- --contact = John Doe\n--- --Notice the key-value pairs are not listed in the order they were added.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.delete()", - "userstring.get()" - ] - }, - { - "name": "userstring.delete()", - "webhelpfile": "13989.htm", - "signature": "userstring.delete(name)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a user-defined string from nonvolatile memory.", - "details": "This function deletes the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "name", - "description": "The name (key) of the key-value pair of the user-defined string to delete", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "userstring.delete(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.delete(\"assetnumber\");userstring.delete(\"product\");userstring.delete(\"contact\");", - "description": "Deletes the user-defined strings associated with the assetnumber, product, and contact names.\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.get()" - ] - }, - { - "name": "userstring.get()", - "webhelpfile": "13990.htm", - "signature": "userstring.get(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves a user-defined string from nonvolatile memory.", - "details": "This function retrieves the string that is associated with name from nonvolatile memory.", - "param_info": [ - { - "name": "value", - "description": "The value of the user-defined string key-value pair", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "name", - "description": "The name (key) of the user-defined string", - "enum": "", - "type": "string", - "range": "(key)" - } - ], - "usage": [ - "value = userstring.get(name)" - ], - "overloads": [], - "examples": [ - { - "example": "userstring.add(\"assetnumber\", \"236\");value = userstring.get(\"assetnumber\");print(value);", - "description": "Create the user-defined string assetnumber, set to a value of 236.\n--- --Read the value associated with the user-defined string named assetnumber.\n--- --Store it in a variable called value, then print the variable value.\n--- --Output:\n--- --236\n" - } - ], - "related_commands": [ - "userstring.add()", - "userstring.catalog()", - "userstring.delete()" - ] - }, - { - "name": "upgrade.previous()", - "webhelpfile": "14062.htm", - "signature": "upgrade.previous()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns to a previous version of the DMM7510 firmware.", - "details": "This function allows you to revert to an earlier version of the firmware.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument performs the upgrade. An error is returned if an upgrade file is not found.", - "param_info": [], - "usage": [ - "upgrade.previous()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "Upgrading the firmware", - "upgrade.unit()" - ] - }, - { - "name": "upgrade.unit()", - "webhelpfile": "14063.htm", - "signature": "upgrade.unit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function upgrades the DMM7510 firmware.", - "details": "When upgrade.unit() is used, the firmware is only loaded if the version of the firmware is newer than the existing version. If the version is older or at the same revision level, it is not upgraded.When you send this function, the instrument searches the USB flash drive in the front-panel USB port for an upgrade file. If the file is found, the instrument verifies that the file is a newer version. If the version is older or at the same revision level, it is not upgraded, although it does request a reboot. If it is a newer version, the instrument performs the upgrade. An error event message is returned if no upgrade file is found.", - "param_info": [], - "usage": [ - "upgrade.unit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "upgrade.previous()", - "Upgrading the firmware" - ] - }, - { - "name": "tspnet.clear()", - "webhelpfile": "14073.htm", - "signature": "tspnet.clear(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending output data from the instrument.", - "details": "This function clears any pending output data from the device. No data is returned to the caller and no data is processed.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.clear(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(testdevice, \"print([[hello]])\");print(tspnet.readavailable(testdevice));\u00a0;\u00a0;\u00a0;tspnet.clear(testdevice);print(tspnet.readavailable(testdevice));", - "description": "Write data to a device, then print how much is available.\n--- --Output:\n--- --6.00000e+00\n--- --\u00a0\n--- --Clear data and print how much data is available again.\n--- --Output:\n--- --0.00000e+00\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.connect()", - "webhelpfile": "14074.htm", - "signature": "tspnet.connect(ipAddress, portNumber, initString)", - "command_return": "connectionID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function establishes a network connection with another LAN instrument or device through the LAN interface.", - "details": "This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.If a portNumber and initString are provided, it is assumed that the remote device is not TSP-enabled. The DMM7510 does not perform any extra processing, prompt handling, error handling, or sending of commands. In addition, the tspnet.tsp.* commands cannot be used on devices that are not TSP-enabled.If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP-enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the DMM7510 sends an abort command to the remote device on connection. You can simultaneously connect to a maximum of 32 remote devices.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID to be used as a handle in all other tspnet function calls", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "ipAddress", - "description": "IP address to which to connect in a string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "portNumber", - "description": "Port number (default 5025)", - "enum": "", - "type": "number", - "range": "(default 5025)" - }, - { - "name": "initString", - "description": "Initialization string to send to ipAddress", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "connectionID = tspnet.connect(ipAddress)", - "connectionID = tspnet.connect(ipAddress, portNumber, initString)" - ], - "overloads": [ - "connectionID = tspnet.connect(ipAddress)" - ], - "examples": [ - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a TSP-enabled device.\n" - }, - { - "example": "instrumentID = tspnet.connect(\"192.0.2.1\", 1394, \"*rst\\r\\n\");if instrumentID then; -- Use instrumentID as needed here; tspnet.disconnect(instrumentID);end;", - "description": "Connect to a device that is not TSP-enabled.\n" - } - ], - "related_commands": [ - "localnode.prompts", - "localnode.showevents", - "tspnet.tsp.abortonconnect", - "tspnet.disconnect()" - ] - }, - { - "name": "tspnet.disconnect()", - "webhelpfile": "14076.htm", - "signature": "tspnet.disconnect(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects a specified TSP-Net session.", - "details": "This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().For TSP-enabled devices, this aborts any remotely running commands or scripts.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "tspnet.disconnect(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "testID = tspnet.connect(\"192.0.2.0\");-- Use the connection;tspnet.disconnect(testID);", - "description": "Create a TSP-Net session.\n--- --\u00a0\n--- --Close the session.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.execute()", - "webhelpfile": "14077.htm", - "signature": "tspnet.execute(connectionID, commandString, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sends a command string to the remote device.", - "details": "This command sends a command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The DMM7510 decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).When this command is sent to a TSP-enabled instrument, the DMM7510 suspends operation until a timeout error is generated or until the instrument responds. The TSP prompt from the remote instrument is read and discarded. The DMM7510 places any remotely generated errors and events into its event queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "commandString", - "description": "The command to send to the remote device", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The Nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "formatString", - "description": "Format string for the output", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.execute(connectionID, commandString)", - "... = tspnet.execute(connectionID, commandString, formatString)" - ], - "overloads": [ - "... = tspnet.execute(connectionID, commandString)" - ], - "examples": [ - { - "example": "tspnet.execute(instrumentID, \"runScript()\");", - "description": "Command the remote device to run a script named runScript.\n" - }, - { - "example": "tspnet.timeout = 5;id_instr = tspnet.connect(\"192.0.2.23\", 23, \"*rst\\r\\n\");tspnet.termination(id_instr, tspnet.TERM_CRLF);tspnet.execute(id_instr, \"*idn?\");print(\"tspnet.execute returns:\", tspnet.read(id_instr));", - "description": "Print the *idn? string from the remote device.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()", - "tspnet.termination()", - "tspnet.write()" - ] - }, - { - "name": "tspnet.idn()", - "webhelpfile": "14078.htm", - "signature": "tspnet.idn(connectionID)", - "command_return": "idnString", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function retrieves the response of the remote device to *IDN?.", - "details": "This function retrieves the response of the remote device to *IDN?.", - "param_info": [ - { - "name": "idnString", - "description": "The returned *IDN? string", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "idnString = tspnet.idn(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");print(tspnet.idn(deviceID));tspnet.disconnect(deviceID);", - "description": "Assume the instrument is at IP address 192.0.2.1.\n--- --The output that is produced when you connect to the instrument and read the identification string may appear as:\n--- --KEITHLEY INSTRUMENTS,MODEL DMM7510,00000170,1.0.0a\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.read()", - "webhelpfile": "14079.htm", - "signature": "tspnet.read(connectionID, formatString)", - "command_return": "...", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a remote device.", - "details": "This command reads available data from the remote instrument and returns responses for the specified number of arguments.The format string can contain the following specifiers:A maximum of 10 format specifiers can be used for a maximum of 10 return values.If formatString is not provided, the command returns a string that contains the data until a new line is reached. If no data is available, the DMM7510 pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.When the DMM7510 reads from a TSP-enabled remote instrument, the DMM7510 removes Test Script Processor (TSP\u00ae) prompts and places any errors or events it receives from the remote instrument into its own event queue. The DMM7510 prefaces events and errors from the remote device with Remote Error, followed by the event number and description.", - "param_info": [ - { - "name": "value1", - "description": "The first value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second value decoded from the response message", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The nth value decoded from the response message; there is one return value for each format specifier in the format string", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number|string|...", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "formatString", - "description": "Format string for the output, maximum of 10 specifiers", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "... = tspnet.read(connectionID)", - "... = tspnet.read(connectionID, formatString)" - ], - "overloads": [ - "... = tspnet.read(connectionID)" - ], - "examples": [ - { - "example": "tspnet.write(deviceID, \"*idn?\\r\\n\");\u00a0;print(\"write/read returns:\", tspnet.read(deviceID));", - "description": "Send the \"*idn?\\r\\n\" message to the instrument connected as deviceID.\n--- --Display the response that is read from deviceID (based on the *idn? message).\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.readavailable()", - "tspnet.timeout", - "tspnet.write()" - ] - }, - { - "name": "tspnet.readavailable()", - "webhelpfile": "14080.htm", - "signature": "tspnet.readavailable(connectionID)", - "command_return": "bytesAvailable", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks to see if data is available from the remote device.", - "details": "This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.", - "param_info": [ - { - "name": "bytesAvailable", - "description": "The number of bytes available to be read from the connection", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - } - ], - "usage": [ - "bytesAvailable = tspnet.readavailable(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "ID = tspnet.connect(\"192.0.2.1\");tspnet.write(ID, \"*idn?\\r\\n\");\u00a0;repeat bytes = tspnet.readavailable(ID) until bytes > 0;\u00a0;print(tspnet.read(ID));tspnet.disconnect(ID);", - "description": "Send commands that will create data.\n--- --\u00a0\n--- --Wait for data to be available.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.reset()", - "webhelpfile": "14081.htm", - "signature": "tspnet.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function disconnects all TSP-Net sessions.", - "details": "This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.", - "param_info": [], - "usage": [ - "tspnet.reset()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.timeout", - "webhelpfile": "14084.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "20.0 (20 s)\n", - "tsp_link": "No\n", - "description": "This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands. ", - "details": "This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands will wait for a response.The time is specified in seconds. The timeout may be specified to millisecond resolution but is only accurate to the nearest 10\u00a0ms.", - "param_info": [ - { - "name": "value", - "description": "The timeout duration in seconds (1\u00a0ms to 30.0\u00a0s)", - "enum": "", - "type": "number", - "range": "(1\u00a0ms to 30.0\u00a0s)" - } - ], - "usage": [ - "value = tspnet.timeout", - "tspnet.timeout = value" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.timeout = 2.0;", - "description": "Sets the timeout duration to 2 s.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.execute()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.abort()", - "webhelpfile": "14085.htm", - "signature": "tspnet.tsp.abort(connectionID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function causes the TSP-enabled instrument to stop executing any of the commands that were sent to it.", - "details": "This function is appropriate only for TSP-enabled instruments.Sends an abort command to the remote instrument.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abort(connectionID)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abort(testConnection);", - "description": "Stops remote instrument execution on testConnection.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.abortonconnect", - "webhelpfile": "14086.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (enable)\n", - "tsp_link": "No\n", - "description": "This attribute contains the setting for abort on connect to a TSP-enabled instrument.", - "details": "This setting determines if the instrument sends an abort message when it attempts to connect to a TSP-enabled instrument using the tspnet.connect() function.When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP-enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent.", - "param_info": [ - { - "name": "value", - "description": "Enable", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.abortonconnect = value", - "value = tspnet.tsp.abortonconnect" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.abortonconnect = 0;", - "description": "Configure the instrument so that it does not send an abort command when connecting to a TSP-enabled instrument.\n" - } - ], - "related_commands": [ - "tspnet.connect()" - ] - }, - { - "name": "tspnet.write()", - "webhelpfile": "14089.htm", - "signature": "tspnet.write(connectionID, inputString)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes a string to the remote instrument.", - "details": "The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.The DMM7510 sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.", - "param_info": [ - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "inputString", - "description": "The string to be written", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.write(connectionID, inputString)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.write(myID, \"runscript()\\r\\n\");", - "description": "Commands the remote instrument to execute a command or script named runscript() on a remote device identified in the system as myID.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.read()" - ] - }, - { - "name": "tspnet.tsp.rbtablecopy()", - "webhelpfile": "14090.htm", - "signature": "tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)", - "command_return": "table", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.", - "details": "This function is only appropriate for TSP-enabled instruments.This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. The function returns a table if the table is an array of numbers; otherwise a comma-delimited string is returned.This command is limited to transferring 50,000 readings at a time.", - "param_info": [ - { - "name": "table", - "description": "A copy of the synchronous table or a string", - "enum": "", - "type": "table", - "range": "" - }, - { - "name": "connectionID", - "description": "Integer value used as a handle for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The full name of the reading buffer name and synchronous table to copy", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "startIndex", - "description": "Integer start value", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Integer end value", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)", - "table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)" - ], - "overloads": [ - "table = tspnet.tsp.rbtablecopy(connectionID, name)" - ], - "examples": [ - { - "example": "tspnet.timeout = 5;-- change the IP address in the following command;ID = tspnet.connect(\"134.63.79.7\");tspnet.write(ID, \"login admin\\r\\n\");print(tspnet.read(ID));tspnet.write(ID, \"*idn?\\r\\n\");print(tspnet.read(ID));print(eventlog.next());times =; tspnet.tsp.rbtablecopy(ID,; \"defbuffer1.timestamps\", 1, 3);print(times);tspnet.disconnect(ID);", - "description": "Connect to another TSP-Net enabled instrument. Copy the specified timestamps table for items 1 through 3, then display the table. Example output:\n--- --SUCCESS: Logged in\n--- --KEITHLEY INSTRUMENTS,MODEL DMM7510,04089762,1.6.3d\n--- --0\tNo error\t0\t0\t0\t0\n--- --05/19/2017 13:10:43.948592060,05/19/2017 13:10:44.017861380,05/19/2017 13:10:44.087080980\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dataqueue.add()", - "webhelpfile": "14654.htm", - "signature": "dataqueue.add(value, timeout)", - "command_return": "result", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function adds an entry to the data queue.", - "details": "You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).The timeout value is ignored if the data queue is not full.The dataqueue.add() function returns false:If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "result", - "description": "The resulting value of true or false based on the success of the function", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "value", - "description": "The data item to add; value can be of any type", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The maximum number of seconds to wait for space in the data queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "result = dataqueue.add(value)", - "result = dataqueue.add(value, timeout)" - ], - "overloads": [ - "result = dataqueue.add(value)" - ], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(10);dataqueue.add(11, 2);result = dataqueue.add(12, 3);if result == false then; print(\"Failed to add 12 to the dataqueue\");end;print(\"The dataqueue contains:\");while dataqueue.count > 0 do; print(dataqueue.next());end;", - "description": "Clear the data queue.\n--- --Each line adds one item to the data queue.\n--- --Output:\n--- --The dataqueue contains:\n--- --10\n--- --11\n--- --12\n" - } - ], - "related_commands": [ - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.clear()", - "webhelpfile": "14655.htm", - "signature": "dataqueue.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the data queue.", - "details": "This function forces all dataqueue.add() commands that are in progress to time out and deletes all data from the data queue.", - "param_info": [ - { - "name": "MaxCount = dataqueue.CAPACITYwhile dataqueue.count < MaxCount do dataqueue.add(1)endprint(\"There are \" .. dataqueue.count .. \" items in the data queue\")dataqueue.clear()print(\"There are \" .. dataqueue.count .. \" items in the data queue\")", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dataqueue.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the dataqueue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.CAPACITY", - "webhelpfile": "14656.htm", - "signature": "", - "command_return": "count", - "type": "Constant", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This constant is the maximum number of entries that you can store in the data queue.", - "details": "This constant always returns the maximum number of entries that can be stored in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The variable that is assigned the value of dataqueue.CAPACITY", - "enum": "dataqueue.CAPACITY nil", - "type": "dataqueueCAPACITYcount | integer", - "range": "" - } - ], - "usage": [ - "count = CAPACITY" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue until it is full and prints the number of items in the queue.\n--- --Output:\n--- --There are 128 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.clear()", - "dataqueue.count", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.count", - "webhelpfile": "14657.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of items in the data queue.", - "details": "The count is updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the data queue is cleared with dataqueue.clear().A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.", - "param_info": [ - { - "name": "count", - "description": "The number of items in the data queue", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "count = dataqueue.count" - ], - "overloads": [], - "examples": [ - { - "example": "MaxCount = dataqueue.CAPACITY;while dataqueue.count < MaxCount do; dataqueue.add(1);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");dataqueue.clear();print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.\n--- --Output:\n--- --There are 128 items in the data queue\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.next()", - "Using the data queue for real-time communication" - ] - }, - { - "name": "dataqueue.next()", - "webhelpfile": "14658.htm", - "signature": "dataqueue.next(timeout)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes the next entry from the data queue.", - "details": "If the data queue is empty, the function waits up to the timeout value.If data is not available in the data queue before the timeout expires, the return value is nil.The entries in the data queue are removed in first-in, first-out (FIFO) order.If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.", - "param_info": [ - { - "name": "value", - "description": "The next entry in the data queue", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "timeout", - "description": "The number of seconds to wait for data in the queue", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dataqueue.next()", - "value = dataqueue.next(timeout)" - ], - "overloads": [ - "value = dataqueue.next()" - ], - "examples": [ - { - "example": "dataqueue.clear();for i = 1, 10 do; dataqueue.add(i);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");\u00a0;while dataqueue.count > 0 do; x = dataqueue.next(); print(x);end;print(\"There are \" .. dataqueue.count; .. \" items in the data queue\");", - "description": "Clears the data queue, adds ten entries, then reads the entries from the data queue. Note that your output may differ depending on the setting of format.asciiprecision.\n--- --Output:\n--- --There are 10 items in the data queue\n--- --1\n--- --2\n--- --3\n--- --4\n--- --5\n--- --6\n--- --7\n--- --8\n--- --9\n--- --10\n--- --There are 0 items in the data queue\n" - } - ], - "related_commands": [ - "dataqueue.add()", - "dataqueue.CAPACITY", - "dataqueue.clear()", - "dataqueue.count", - "format.asciiprecision", - "Using the data queue for real-time communication" - ] - }, - { - "name": "exit()", - "webhelpfile": "14769.htm", - "signature": "exit()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function stops a script that is presently running.", - "details": "Terminates script execution when called from a script that is being executed.This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().", - "param_info": [], - "usage": [ - "exit()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "fs.chdir()", - "webhelpfile": "14808.htm", - "signature": "fs.chdir(path)", - "command_return": "workingDirectory", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the current working directory.", - "details": "The new working directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the given path does not exist.", - "param_info": [ - { - "name": "workingDirectory", - "description": "Returned value containing the working path", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "path", - "description": "A string indicating the new working directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "workingDirectory = fs.chdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.cwd()", - "webhelpfile": "14810.htm", - "signature": "fs.cwd()", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the absolute path of the current working directory.", - "details": "", - "param_info": [ - { - "name": "path", - "description": "The absolute path of the current working directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "path = fs.cwd()" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == true then;\u00a0 fs.chdir(\"/usb1/temp\");\u00a0 testPath = fs.cwd();\u00a0 print(testPath);else;\u00a0 testPath = fs.cwd();\u00a0 print(testPath);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Verify that /usb1/temp is a directory and change it to be the current working directory.\n--- --Set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1/temp\n--- --If /usb1/temp is not a directory, set the variable for the current working directory to be testPath.\n--- --The return should be:\n--- --/usb1\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.is_dir()", - "webhelpfile": "14811.htm", - "signature": "fs.is_dir(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function tests whether or not the specified path refers to a directory.", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "Whether or not the given path is a directory (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_dir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "print(\"Is directory: \", fs.is_dir(\"/usb1/\"));", - "description": "Because /usb1/ is always the root directory of an inserted flash drive, you can use this command to verify that USB flash drive is inserted.\n" - }, - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.is_file()" - ] - }, - { - "name": "fs.mkdir()", - "webhelpfile": "14812.htm", - "signature": "fs.mkdir(newpath)", - "command_return": "path", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a directory at the specified path.", - "details": "The directory path may be absolute or relative to the current working directory.An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.", - "param_info": [ - { - "name": "path", - "description": "The returned path of the new directory", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "newpath", - "description": "Location (path) of where to create the new directory", - "enum": "", - "type": "string", - "range": "(path)" - } - ], - "usage": [ - "path = fs.mkdir(newpath)" - ], - "overloads": [], - "examples": [ - { - "example": "if fs.is_dir(\"/usb1/temp\") == false then;\u00a0\u00a0\u00a0 fs.mkdir(\"/usb1/temp\");end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Check to see if the temp directory exists.\n--- --If it does not exist, create a directory named temp.\n" - } - ], - "related_commands": [ - "fs.rmdir()" - ] - }, - { - "name": "fs.readdir()", - "webhelpfile": "14814.htm", - "signature": "fs.readdir(path)", - "command_return": "files", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of the file system entries in the directory.", - "details": "The directory path may be absolute or relative to the current working directory.This command is nonrecursive. For example, entries in subfolders are not returned.An error is logged to the error queue if the given path does not exist or does not represent a directory.", - "param_info": [ - { - "name": "files", - "description": "A table containing the names of all the file system entries in the specified directory", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "path", - "description": "The directory path", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "files = fs.readdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";entries = fs.readdir(rootDirectory);count = table.getn(entries);print(\"Found a total of \"..count..\" files and directories\");for i = 1, count do; print(entries[i]);end;", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set entries as the variable for the file system entries in rootDirectory.\n--- --Return the number of files and directories in the directory.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "fs.rmdir()", - "webhelpfile": "14815.htm", - "signature": "fs.rmdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function removes a directory from the file system.", - "details": "This path may be absolute or relative to the present working directory.An error is logged to the error queue if the given path does not exist or does not represent a directory. An error is also logged if the directory is not empty.", - "param_info": [ - { - "name": "path", - "description": "The path of the directory to remove", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "fs.rmdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";tempDirectoryName = \"temp\";if fs.is_dir(rootDirectory..tempDirectoryName) == false then;\u00a0\u00a0\u00a0 fs.mkdir(rootDirectory..tempDirectoryName);end;fs.rmdir(rootDirectory..tempDirectoryName);", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Set tempDirectoryName to be equivalent to temp.\n--- --Check to see if tempDirectoryName exists.\n--- --If it does not exist, create a directory named temp.\n--- --Remove the directory.\n" - } - ], - "related_commands": [ - "fs.mkdir()" - ] - }, - { - "name": "fs.is_file()", - "webhelpfile": "14824.htm", - "signature": "fs.is_file(path)", - "command_return": "status", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "Tests whether the specified path refers to a file (as opposed to a directory).", - "details": "The file system path may be absolute or relative to the current working system path.", - "param_info": [ - { - "name": "status", - "description": "true if the given path is a file; otherwise, false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "path", - "description": "The path of the file system entry to test", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "status = fs.is_file(path)" - ], - "overloads": [], - "examples": [ - { - "example": "rootDirectory = \"/usb1/\";print(\"Is file: \", fs.is_file(rootDirectory));", - "description": "Insert a USB flash drive into the front panel of the instrument.\n--- --Set rootDirectory to be the USB port.\n--- --Check to see if rootDirectory is a file. Because rootDirectory was set up as a directory, the return is false.\n" - } - ], - "related_commands": [ - "fs.is_dir()" - ] - }, - { - "name": "gpib.address", - "webhelpfile": "14860.htm", - "signature": "", - "command_return": "address", - "type": "Attribute (RW)", - "default_value": "16\n", - "tsp_link": "No\n", - "description": "This attribute contains the GPIB address.", - "details": "The address can be set to any address value from 1 to 30. However, the address must be unique in the system. It cannot conflict with an address that is assigned to another instrument or to the GPIB controller.A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.You should allow sufficient time for the command to be processed before attempting to communicate with the instrument again.The reset() function does not affect the GPIB address.", - "param_info": [ - { - "name": "address", - "description": "The GPIB address of the instrument (1 to 30)", - "enum": "", - "type": "number", - "range": "(1 to 30)" - } - ], - "usage": [ - "address = gpib.address", - "gpib.address = address" - ], - "overloads": [], - "examples": [ - { - "example": "gpib.address = 26;address = gpib.address;print(address);", - "description": "Sets the GPIB address and reads the address.\n--- --Output:\n--- --26\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.lxidomain", - "webhelpfile": "14893.htm", - "signature": "", - "command_return": "domain", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LXI domain.", - "details": "This attribute sets the LXI domain number.All outgoing LXI packets are generated with this domain number. All inbound LXI packets are ignored unless they have this domain number.", - "param_info": [ - { - "name": "domain", - "description": "The LXI domain number (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "domain = lan.lxidomain", - "lan.lxidomain = domain" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.lxidomain);", - "description": "Displays the LXI domain.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "node[N].execute()", - "webhelpfile": "15009.htm", - "signature": "node[N].execute(scriptCode)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes (see Details)\n", - "description": "This function starts test scripts on a remote TSP-Link node. ", - "details": "This command is only applicable to TSP-Link systems. You can use this command to use the remote master node to run a script on the specified node. This function does not run test scripts on the master node; only on the subordinate node when initiated by the master node.This function may only be called when the group number of the node is different than the node of the master.This function does not wait for the script to finish execution.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "scriptCode", - "description": "A string containing the source code", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "node[N].execute(scriptCode)" - ], - "overloads": [], - "examples": [ - { - "example": "node[2].execute(sourcecode);", - "description": "Runs script code on node 2. The code is in a string variable called sourcecode.\n" - }, - { - "example": "node[3].execute(\"x = 5\");", - "description": "Runs script code in string constant (\"x = 5\") to set x equal to 5 on node 3.\n" - }, - { - "example": "node[32].execute(TestDut.source);", - "description": "Runs the test script stored in the variable TestDut\n--- --(previously stored on the master node) on node 32.\n" - } - ], - "related_commands": [ - "tsplink.group" - ] - }, - { - "name": "node[N].getglobal()", - "webhelpfile": "15010.htm", - "signature": "node[N].getglobal(name)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the value of a global variable. ", - "details": "This function retrieves the value of a global variable from the run-time environment of this node.Do not use this command to retrieve the value of a global variable from the local node. Instead, access the global variable directly. This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "value", - "description": "The value of the variable", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "value = node[N].getglobal(name)" - ], - "overloads": [], - "examples": [ - { - "example": "print(node[5].getglobal(\"test_val\"));", - "description": "Retrieves and outputs the value of the global variable named test_val from node 5.\n" - } - ], - "related_commands": [ - "node[N].setglobal()" - ] - }, - { - "name": "localnode.model", - "webhelpfile": "15013.htm", - "signature": "", - "command_return": "model", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the model number.", - "details": "", - "param_info": [ - { - "name": "model", - "description": "The model number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "model = localnode.model" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.model);", - "description": "Outputs the model number of the local node. For example:\n--- --DMM7510 \n" - } - ], - "related_commands": [ - "localnode.serialno" - ] - }, - { - "name": "node[N].setglobal()", - "webhelpfile": "15020.htm", - "signature": "node[N].setglobal(name, value)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the value of a global variable. ", - "details": "From a remote node, use this function to assign the given value to a global variable.Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-Link network.", - "param_info": [ - { - "name": "N", - "description": "The node number of this instrument (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - }, - { - "name": "name", - "description": "The global variable name to set", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "value", - "description": "The value to assign to the variable", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "node[N].setglobal(name, value)" - ], - "overloads": [], - "examples": [ - { - "example": "node[3].setglobal(\"x\", 5);", - "description": "Sets the global variable x on node 3 to the value of 5.\n" - } - ], - "related_commands": [ - "node[N].getglobal()" - ] - }, - { - "name": "printbuffer()", - "webhelpfile": "15057.htm", - "signature": "printbuffer(startIndex, endIndex, bufferVar, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints data from tables or reading buffer subtables.", - "details": "If startIndex is set to less than 1 or if endIndex is more than the size of the index, 9.910000e+37 is returned for each value outside the allowed index and an event is generated.If overlapped commands use the specified reading buffers and the commands are not complete (at least to the specified index), this function outputs data as it becomes available.When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table has after all the readings have completed.If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer is used.This command generates a single response message that contains all data.The output of printbuffer() is affected by the data format selected by format.data. If you set format.data to format.REAL32 or format.REAL64, you have fewer options for buffer elements. With these formats, the only buffer elements available are readings, relativetimestamps, and extravalues. If you request a buffer element that is not permitted for the selected data format, the instrument returns 9.91e37.You can use the bufferVar attributes that are listed in the following table with the print buffer command. For example, if testData is the buffer, you can use testData.dates attribute to print the date of each reading in the testData buffer.You can use bufferVar.n to retrieve the number of readings in the specified reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Beginning index of the buffer to print; this must be more than one and less than endIndex", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "endIndex", - "description": "Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "Name of first table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVar2", - "description": "Second table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "bufferVarN", - "description": "The last table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "...", - "description": "One or more tables or reading buffer subtables separated with commas", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "printbuffer(startIndex, endIndex, bufferVar, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();dmm.measure.func = dmm.FUNC_DC_CURRENT;testData = buffer.make(200);format.data = format.ASCII;format.asciiprecision = 6;trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.readings, testData.units, testData.relativetimestamps);", - "description": "Reset the instrument.\n--- --Set the measure function to DC current.\n--- --Set the data format and ASCII precision.\n--- --Use trigger model SimpleLoop to create a 6-count loop with no delays that stores data in the reading buffer testBuffer.\n--- --Start the trigger model, wait for the commands to complete, and output the readings.\n--- --Use of testData.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, testBuffer.n equals 6.\n--- --Example of output data: \n--- --1.10458e-11, Amp DC, 0.00000e+00, 1.19908e-11, Amp DC, 1.01858e-01, 1.19908e-11, Amp DC, 2.03718e-01, 1.20325e-11, Amp DC, 3.05581e-01, 1.20603e-11, Amp DC, 4.07440e-01, 1.20325e-11, Amp DC, 5.09299e-01\n" - }, - { - "example": "for x = 1, testData.n do; printbuffer(x,x,testData, testData.units, testData.relativetimestamps);end;", - "description": "Using the same buffer created in Example 1, output the readings, units and relative timestamps on a separate line for each reading.\n--- --1.10458e-11, Amp DC, 0.00000e+00\n--- --1.19908e-11, Amp DC, 1.01858e-01\n--- --1.19908e-11, Amp DC, 2.03718e-01\n--- --1.20325e-11, Amp DC, 3.05581e-01\n--- --1.20603e-11, Amp DC, 4.07440e-01\n--- --1.20325e-11, Amp DC, 5.09299e-01\n" - } - ], - "related_commands": [ - "bufferVar.n", - "bufferVar.readings", - "format.asciiprecision", - "format.byteorder", - "format.data", - "printnumber()" - ] - }, - { - "name": "printnumber()", - "webhelpfile": "15058.htm", - "signature": "printnumber(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function prints numbers using the configured format.", - "details": "There are multiple ways to use this function, depending on how many numbers are to be printed.This function prints the given numbers using the data format specified by format.data and format.asciiprecision.", - "param_info": [ - { - "name": "value1", - "description": "First value to print in the configured format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "value2", - "description": "Second value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "Last value to print in the configured format", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "printnumber(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x, 2.54321, 3.1);", - "description": "Configure the ASCII precision to 10 and set x to 2.54.\n--- --Read the value of x based on these settings.\n--- --Change the ASCII precision to 3.\n--- --View how the change affects the output of x and some numbers.\n--- --Output:\n--- --2.540000000e+00\n--- --2.54e+00, 2.54e+00, 3.10e+00\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "format.data", - "print()", - "printbuffer()" - ] - }, - { - "name": "tsplink.group", - "webhelpfile": "15285.htm", - "signature": "", - "command_return": "groupNumber", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the group number of a TSP-Link node. ", - "details": "To remove the node from all groups, set the attribute value to 0.When the node is turned off, the group number for that node changes to 0.The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.", - "param_info": [ - { - "name": "groupNumber", - "description": "The group number of the TSP-Link node (0 to 64)", - "enum": "", - "type": "number", - "range": "(0 to 64)" - } - ], - "usage": [ - "groupNumber = tsplink.group", - "tsplink.group = groupNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.group = 3;", - "description": "Assign the instrument to TSP-Link group number 3.\n" - } - ], - "related_commands": [ - "Using groups to manage nodes on a TSP-Link system" - ] - }, - { - "name": "tsplink.node", - "webhelpfile": "15287.htm", - "signature": "", - "command_return": "nodeNumber", - "type": "Attribute (RW)", - "default_value": "2\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the node number. ", - "details": "This command sets the TSP-Link node number and saves the value in nonvolatile memory.Changes to the node number do not take effect until tsplink.reset() from an earlier TSP-Link instrument or tsplink.initialize() is executed on any node in the system.Each node connected to the TSP-Link system must be assigned a different node number.", - "param_info": [ - { - "name": "nodeNumber", - "description": "The node number of the instrument or enclosure (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "nodeNumber = tsplink.node", - "tsplink.node = nodeNumber" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.node = 3;", - "description": "Sets the TSP-Link node for this instrument to number\u00a03.\n" - } - ], - "related_commands": [ - "tsplink.initialize()", - "tsplink.state" - ] - }, - { - "name": "tsplink.readport()", - "webhelpfile": "15289.htm", - "signature": "tsplink.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the TSP-Link trigger lines as a digital I/O port. ", - "details": "The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and the value of bit 3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. This indicates that line 2 is high (1), and that the other two lines are low (0).", - "param_info": [ - { - "name": "data", - "description": "Numeric value that indicates which lines are set", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "data = tsplink.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = tsplink.readport();print(data);", - "description": "Reads state of all three TSP-Link lines.\n--- --Assuming line 2 is set high, the output is:\n--- --2.000000e+00\n--- --(binary 010)\n--- --The format of the output may vary depending on the ASCII precision setting.\n" - } - ], - "related_commands": [ - "Triggering using TSP-Link trigger lines", - "tsplink.line[N].state", - "tsplink.writeport()" - ] - }, - { - "name": "tsplink.state", - "webhelpfile": "15291.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the TSP-Link online state. ", - "details": "When the instrument power is first turned on, the state is offline. After tsplink.initialize() or tsplink.reset() is successful, the state is online.", - "param_info": [ - { - "name": "state", - "description": "TSP-Link state (online or offline)", - "enum": "", - "type": "\"online\" | \"offline\"", - "range": "(online or offline)" - } - ], - "usage": [ - "state = tsplink.state" - ], - "overloads": [], - "examples": [ - { - "example": "state = tsplink.state;print(state);", - "description": "Read the state of the TSP-Link system. If it is online, the output is:\n--- --online\n" - } - ], - "related_commands": [ - "tsplink.node" - ] - }, - { - "name": "tsplink.writeport()", - "webhelpfile": "15302.htm", - "signature": "tsplink.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all TSP-Link synchronization lines as a digital I/O port. ", - "details": "The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).The reset() function does not affect the present states of the trigger lines.", - "param_info": [ - { - "name": "data", - "description": "Value to write to the port (0 to 7)", - "enum": "", - "type": "number", - "range": "(0 to 7)" - } - ], - "usage": [ - "tsplink.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeport(3);", - "description": "Sets the synchronization lines 1 and 2 high (binary 011).\n" - } - ], - "related_commands": [ - "tsplink.line[N].state" - ] - }, - { - "name": "trigger.blender[N].clear()", - "webhelpfile": "15785.htm", - "signature": "trigger.blender[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the blender event detector and resets the overrun indicator of blender N.", - "details": "This command sets the blender event detector to the undetected state and resets the overrun indicator of the event detector.", - "param_info": [ - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[2].clear();", - "description": "Clears the event detector for blender 2.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].orenable", - "webhelpfile": "15787.htm", - "signature": "", - "command_return": "orenable", - "type": "Attribute (RW)", - "default_value": "false (AND)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects whether the blender performs OR operations or AND operations.", - "details": "This command selects whether the blender waits for any one event (OR) or waits for all selected events (AND) before signaling an output event.", - "param_info": [ - { - "name": "orenable", - "description": "The type of operation", - "enum": "", - "type": "boolean | true | false", - "range": "" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "orenable = trigger.blender[N].orenable", - "trigger.blender[N].orenable = orenable" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.blender[N].overrun", - "webhelpfile": "15788.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates whether or not an event was ignored because of the event detector state.", - "details": "Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.This command does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger blender overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The blender number (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "overrun = trigger.blender[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.blender[1].overrun);", - "description": "If an event was ignored, the output is true.\n--- --If an event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "trigger.timer[N].clear()", - "webhelpfile": "15793.htm", - "signature": "trigger.timer[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the timer event detector and overrun indicator for the specified trigger timer number.", - "details": "This command sets the timer event detector to the undetected state and resets the overrun indicator.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].clear();", - "description": "Clears trigger timer 1.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count" - ] - }, - { - "name": "trigger.timer[N].delay", - "webhelpfile": "15794.htm", - "signature": "", - "command_return": "interval", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets and reads the timer delay.", - "details": "Once the timer is enabled, each time the timer is triggered, it uses this delay period.Assigning a value to this attribute is equivalent to:This creates a delay list of one value.Reading this attribute returns the delay interval that will be used the next time the timer is triggered.If you use the trigger timer with a trigger model, make sure the trigger timer delay is set so that the readings are paced correctly.", - "param_info": [ - { - "name": "interval", - "description": "Delay interval in seconds (8 \u00b5s to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(8 \u00b5s to 100\u00a0ks)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "interval = trigger.timer[N].delay", - "trigger.timer[N].delay = interval" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].delay = 50e-6;", - "description": "Set the trigger timer 1 to delay for 50\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].delaylist", - "webhelpfile": "15795.htm", - "signature": "", - "command_return": "intervals", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets an array of timer intervals.", - "details": "Each time the timer is triggered after it is enabled, it uses the next delay period from the array. The default value is an array with one value of 10 \u00b5s.After all elements in the array have been used, the delays restart at the beginning of the list.If the array contains more than one element, the average of the delay intervals in the list must be >=\u00a050\u00a0\u00b5s.", - "param_info": [ - { - "name": "intervals", - "description": "Table of delay intervals in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "intervals = trigger.timer[N].delaylist", - "trigger.timer[N].delaylist = intervals" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6};\u00a0;DelayList = trigger.timer[3].delaylist;for x = 1, table.getn(DelayList) do; print(DelayList[x]);end;", - "description": "Set a delay list on trigger timer 3 with three delays (50 \u00b5s, 100 \u00b5s, and 150 \u00b5s).\n--- --\u00a0\n--- --Read the delay list on trigger timer\u00a03.\n--- --\u00a0\n--- --Output:\n--- --5e-05\n--- --0.0001\n--- --0.00015\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].wait()", - "webhelpfile": "15800.htm", - "signature": "trigger.timer[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.timer[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.timer[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on timer 3.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()" - ] - }, - { - "name": "trigger.timer[N].count", - "webhelpfile": "15820.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of events to generate each time the timer generates a trigger event or is enabled as a timer or alarm.", - "details": "If the count is set to a number greater than 1, the timer automatically starts the next trigger timer delay at the expiration of the previous delay.Set the count to zero (0) to cause the timer to generate trigger events indefinitely.If you use the trigger timer with a trigger model, make sure the count value is the same or more than any count values expected in the trigger model.", - "param_info": [ - { - "name": "count", - "description": "Number of times to repeat the trigger (0 to 1,048,575)", - "enum": "", - "type": "number", - "range": "(0 to 1,048,575)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "count = trigger.timer[N].count", - "trigger.timer[N].count = count" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].count);", - "description": "Read trigger count for timer number 1.\n" - }, - { - "example": "reset();trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;\u00a0;trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY8);trigger.model.setblock(3, trigger.BLOCK_WAIT, trigger.EVENT_TIMER4);trigger.model.setblock(4, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 20, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n--- --\u00a0\n--- --Clear the trigger model.\n--- --Set trigger model block 1 to clear the buffer.\n--- --Set trigger model block 2 to generate the notify 8 event.\n--- --Set trigger model block 3 to wait for the trigger timer 4 to occur.\n--- --Set trigger model block 4 to make or digitize a measurement and store it in default buffer 1.\n--- --Set trigger model block 5 to repeat the trigger model 20 times, starting at block 3.\n--- --Start the trigger model.\n--- --Wait until all commands are complete.\n--- --Print the number of entries in default buffer 1.\n--- --\u00a0\n--- --Output:\n--- --20\n" - } - ], - "related_commands": [ - "trigger.timer[N].clear()", - "trigger.timer[N].delay", - "trigger.timer[N].reset()" - ] - }, - { - "name": "dmm.measure.simreftemperature", - "webhelpfile": "16068.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Celsius: 23Kelvin: 296.15Fahrenheit: 73.4\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the simulated reference temperature of the thermocouple reference junction.", - "details": "This attribute applies to the temperature function when the transducer type is set to thermocouple and the reference junction is set to simulated. It allows you to set the simulated reference temperature value.", - "param_info": [ - { - "name": "value", - "description": "The simulated reference temperature", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.simreftemperature", - "dmm.measure.simreftemperature = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_SIM_REF_TEMP)", - "dmm.measure.setattribute(function, ATTR_MEAS_SIM_REF_TEMP, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THERMOCOUPLE;dmm.measure.unit = dmm.UNIT_CELSIUS;dmm.measure.simreftemperature = 30;", - "description": "Sets 30 degrees Celsius as the simulated reference temperature for thermocouples.\n" - } - ], - "related_commands": [ - "dmm.measure.transducer", - "Temperature measurements" - ] - }, - { - "name": "scriptVar.run()", - "webhelpfile": "16856.htm", - "signature": "scriptVar.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function runs a script.", - "details": "The scriptVar.run() function runs the script referenced by scriptVar. You can also run the script by using scriptVar().", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of the variable that references the script", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scriptVar.run()", - "scriptVar()" - ], - "overloads": [], - "examples": [ - { - "example": "test8.run();", - "description": "Runs the script referenced by the variable test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "scriptVar.save()", - "webhelpfile": "16863.htm", - "signature": "scriptVar.save(filename)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function saves the script to nonvolatile memory or to a USB flash drive.", - "details": "The scriptVar.save() function saves a script to nonvolatile memory or a USB flash drive. The root folder of the USB flash drive has the absolute path /usb1/.If no filename is specified, the script is saved to internal nonvolatile memory. If a filename is given, the script is saved to the USB flash drive.If you set scriptVar to autoexec, the script is run when the instrument powers up. You must delete the existing autoexec script before saving the new one. Note that performing a system reset does not delete the autoexec script.You can add the file extension, but it is not required. The only allowed extension is .tsp (see Example\u00a02).", - "param_info": [ - { - "name": "scriptVar", - "description": "The name of variable that references the script", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "filename", - "description": "A string that contains the file name to use when saving the script to a USB flash drive", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "scriptVar.save()", - "scriptVar.save(filename)" - ], - "overloads": [ - "scriptVar.save()" - ], - "examples": [ - { - "example": "test8.save();", - "description": "Saves the script referenced by the variable test8 to nonvolatile memory.\n" - }, - { - "example": "test8.save(\"/usb1/myScript.tsp\");", - "description": "Saves the script referenced by the variable test8 to a file named myScript.tsp on your USB flash drive.\n" - } - ], - "related_commands": [ - "Working with scripts" - ] - }, - { - "name": "channel.close()", - "webhelpfile": "17229.htm", - "signature": "channel.close(channelList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function closes the channels and channel patterns that are specified by the channel list parameter without opening any channels.", - "details": "Channels closed with this command are appended to the already closed channels (no previously closed channels are opened by this command).Actions associated with this function include:An error is generated if:Once an error is detected, the command stops processing and no channels are closed. ", - "param_info": [ - { - "name": "channelList", - "description": "A string that lists the channels and channel patterns to close", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "channel.close(channelList)" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "channel.exclusiveclose()", - "channel.exclusiveslotclose()", - "channel.getclose()", - "channel.open()" - ] - }, - { - "name": "channel.open()", - "webhelpfile": "17548.htm", - "signature": "channel.open(channelList)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function opens the specified channels and channel patterns.", - "details": "This function opens the specified channels based on the channel's switching configuration.The settling time associated with a channel must elapse before the command completes. User delay is not added when a relay opens.", - "param_info": [ - { - "name": "channelList", - "description": "String listing the channels and channel patterns to open", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "channel.open(channelList)" - ], - "overloads": [], - "examples": [ - { - "example": "channelList;", - "description": "String listing the channels and channel patterns to open\n" - }, - { - "example": "channel.open(\"slot3, slot5\");", - "description": "Opens all channels on slots 3 and 5.\n" - }, - { - "example": "channel.open(\"allslots\");", - "description": "Opens all channels on all slots.\n" - } - ], - "related_commands": [ - "channel.close()", - "channel.exclusiveclose()", - "channel.exclusiveslotclose()", - "channel.getclose()", - "channel.getdelay()", - "channel.pattern.getimage()", - "channel.pattern.setimage()", - "channel.pattern.snapshot()", - "channel.getstate()", - "channel.setdelay() ", - "channel.setforbidden() " - ] - }, - { - "name": "tsplink.writeprotect", - "webhelpfile": "17630.htm", - "signature": "", - "command_return": "mask", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the write\u2011protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions. This attribute is not available on the Models 2604A/2614A/2634A.", - "details": "The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write\u2011protects TSP-Link trigger lines 1 and 3.", - "param_info": [ - { - "name": "mask", - "description": "An integer that specifies the value of the bit pattern for write\u2011protect; set bits to 1 to write\u2011protect the corresponding TSP-Link trigger line", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "mask = tsplink.writeprotect", - "tsplink.writeprotect = mask" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.writeprotect = 5;", - "description": "Write\u2011protects TSP-Link trigger lines 1 and 3.\n" - } - ], - "related_commands": [ - "tsplink.readbit()", - "tsplink.readport()", - "tsplink.writebit()", - "tsplink.writeport()" - ] - }, - { - "name": "print()", - "webhelpfile": "17645.htm", - "signature": "print(value1, ...)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function generates a response message.", - "details": "TSP-enabled instruments do not have inherent query commands. Like other scripting environments, the print() command and other related print() commands generate output. The print() command creates one response message.The output from multiple arguments is separated with a tab character.Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.", - "param_info": [ - { - "name": "value1", - "description": "The first argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "value2", - "description": "The second argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "valueN", - "description": "The last argument to output", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "...", - "description": "One or more values separated with commas", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "print(value1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "x = 10;print(x);", - "description": "Example of an output response message:\n--- --10\n--- --Note that your output might be different if you set your ASCII precision setting to a different value.\n" - }, - { - "example": "x = true;print(tostring(x));", - "description": "Example of an output response message:\n--- --true\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "trigger.blender[N].reset()", - "webhelpfile": "17666.htm", - "signature": "trigger.blender[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the trigger blender settings to their factory defaults.", - "details": "The trigger.blender[N].reset() function resets the following attributes to their factory defaults:It also clears trigger.blender[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - } - ], - "usage": [ - "trigger.blender[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.blender[1].reset();", - "description": "Resets the trigger blender\u00a01 settings to factory defaults.\n" - } - ], - "related_commands": [ - "trigger.blender[N].orenable", - "trigger.blender[N].overrun", - "trigger.blender[N].stimulus[M]" - ] - }, - { - "name": "buffer.getstats()", - "webhelpfile": "25624.htm", - "signature": "buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "command_return": "statsVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns statistics from a specified reading buffer.", - "details": "This function returns a table with statistical data about the data that was placed in the reading buffer.The instrument automatically updates reading buffer statistics as data is added to the reading buffer.When the reading buffer is configured to fill continuously and overwrite old data with new data, the buffer statistics include the data that was overwritten. To get statistics that do not include data that has been overwritten, define a large buffer size that will accommodate the number of readings you will make. The table returned from this function provides statistics at the time the function is called. Although the instrument continues to update the statistics, the table that is returned is not updated. To get fresh statistics, call this function again.The statsVar parameter contains the values described in the following table.If n equals zero (0), all other values are nil. If n equals 1, stddev is nil because the standard deviation of a sample size of 1 is undefined.Use the following command to get values from statsVar; a table with the following entries in it: n, min, max, mean, and stddev:Use the following commands to print these entries:To print all the entries, send:", - "param_info": [ - { - "name": "statsVar", - "description": "A table that contains the entries for buffer statistics; see Details for information on the entries", - "enum": "", - "type": "statsVar", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "absStartTime", - "description": "An integer that represents the absolute start time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absStartFractional", - "description": "An integer that represents the portion of the absolute start time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndTime", - "description": "An integer that represents the absolute end time in seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "absEndFractional", - "description": "An integer that represents the portion of the absolute end time that is in fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relStartTime", - "description": "The start time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "relEndTime", - "description": "The end time in seconds relative to the start time of the data in the buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, absStartTime, absStartFractional, absEndTime, absEndFractional)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "overloads": [ - "statsVar = buffer.getstats()", - "statsVar = buffer.getstats(bufferVar)", - "statsVar = buffer.getstats(bufferVar, relStartTime, relEndTime)" - ], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 12, 0.001, defbuffer1);trigger.model.initiate();waitcomplete();\u00a0;stats = buffer.getstats(defbuffer1);print(stats);", - "description": "Reset the instrument.\n--- --Set up the SimpleLoop trigger-model template to make 12 readings with a 0.001\u00a0s delay. Readings are stored in defbuffer1.\n--- --Start the trigger model.\n--- --Assign the name stats to the table.\n--- --Get statistics for the default reading buffer named defbuffer1.\n--- --Example output:\n--- --[\"min\"]={[\"seconds\"]=1561123956, [\"fractionalseconds\"]=0.010184587, [\"timestamp\"]=1561123956, [\"reading\"]=8.4974199416e-05}, [\"mean\"]=0.000132948335, [\"stddev\"]=4.4270141937e-05, [\"max\"]={[\"seconds\"]=1561123955, [\"fractionalseconds\"]=0.833083981, [\"timestamp\"]=1561123955.8, [\"reading\"]=0.0002192359033}, [\"n\"]=12\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.model.abort()", - "webhelpfile": "25628.htm", - "signature": "trigger.model.abort()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stops all trigger model commands on the instrument.", - "details": "When this command is received, the instrument stops the trigger model.", - "param_info": [ - { - "name": "trigger.model.abort()", - "description": "Terminates all commands related to the trigger model on the instrument.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.abort()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.abort();", - "description": "Terminates all commands related to the trigger model on the instrument.\n" - } - ], - "related_commands": [ - "Effect of GPIB line events on DMM7510", - "Aborting the trigger model" - ] - }, - { - "name": "buffer.make()", - "webhelpfile": "25629.htm", - "signature": "buffer.make(bufferSize, style)", - "command_return": "bufferVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates a user-defined reading buffer.", - "details": "You cannot assign user-defined reading buffers the name defbuffer1 or defbuffer2. In addition, the buffer name must not already exist as a global variable, a local variable, table, or array.If you create a reading buffer that has the same name as an existing user-defined buffer, the existing buffer is overwritten by the new buffer. Any data in the existing buffer is lost.When you create a reading buffer, it becomes the active buffer. If you create two reading buffers, the last one you create becomes the active buffer.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.The default fill mode of a user-defined buffer is once. You can change it to continuous later.Once the buffer style is selected, it cannot be changed.Once you store the first reading in a compact buffer, you cannot change certain measurement settings, including range, display digits, and units; you must clear the buffer first.Not all remote commands are compatible with the compact, writable, and full writable buffer styles. Check the Details section of the command descriptions before using them with any of these buffer styles.Writable reading buffers are used to bring external data into the instrument. You cannot assign them to collect data from the instrument.You can change the buffer capacity for an existing buffer through the front panel or by using the bufferVar.capacity command.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "bufferSize", - "description": "The maximum number of readings that can be stored in bufferVar; minimum is\u00a010; 0 to maximize buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "style", - "description": "The type of reading buffer to create", - "enum": "buffer.STYLE_COMPACT nil|buffer.STYLE_STANDARD nil|buffer.STYLE_FULL nil|buffer.STYLE_WRITABLE nil|buffer.STYLE_WRITABLE_FULL nil", - "type": "buffermakestyle", - "range": "" - } - ], - "usage": [ - "bufferVar = buffer.make(bufferSize)", - "bufferVar = buffer.make(bufferSize, style)" - ], - "overloads": [ - "bufferVar = buffer.make(bufferSize)" - ], - "examples": [ - { - "example": "capTest2\u00a0= buffer.make(200, buffer.STYLE_FULL);", - "description": "Creates a 200-element reading buffer that stores readings with full accuracy named capTest2.\n" - } - ], - "related_commands": [ - "bufferVar.capacity", - "bufferVar.fillmode", - "buffer.write.format()", - "buffer.write.reading()" - ] - }, - { - "name": "bufferVar.n", - "webhelpfile": "25630.htm", - "signature": "bufferVar.n", - "command_return": "numberOfReadings", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the number of readings in the specified reading buffer.", - "details": "You can call this command to return the number of readings stored in the specified reading buffer.You can use the bufferVar.n attribute in other commands. For example, to print all the readings in a buffer, use the following command:Where bufferVar is the name of the buffer to use.", - "param_info": [ - { - "name": "numberOfReadings", - "description": "The number of readings stored in the reading buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "numberOfReadings = bufferVar.n" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(100);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.n);print(defbuffer1.n);print(defbuffer2.n);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the number of readings in testData.\n--- --Output:\n--- --3\n--- --Print the number of readings in defbuffer1.\n--- --Example output:\n--- --0\n--- --Print the number of readings in defbuffer2.\n--- --Example output:\n--- --0\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "timer.gettime()", - "webhelpfile": "25635.htm", - "signature": "timer.gettime()", - "command_return": "time", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function measures the elapsed time since the timer was last cleared.", - "details": "", - "param_info": [ - { - "name": "time", - "description": "The elapsed time in seconds (1\u00a0\u00b5s resolution)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u00b5s resolution)" - } - ], - "usage": [ - "time = timer.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.cleartime()" - ] - }, - { - "name": "timer.cleartime()", - "webhelpfile": "25636.htm", - "signature": "timer.cleartime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets the timer to zero (0) seconds.", - "details": "", - "param_info": [ - { - "name": "dataqueue.clear()dataqueue.add(35)timer.cleartime()delay(0.5)dt = timer.gettime()print(\"Delay time was \" .. dt)print(dataqueue.next())", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "timer.cleartime()" - ], - "overloads": [], - "examples": [ - { - "example": "dataqueue.clear();dataqueue.add(35);timer.cleartime();delay(0.5);dt = timer.gettime();print(\"Delay time was \" .. dt);print(dataqueue.next());", - "description": "Clear the data queue, add 35 to it, and then delay 0.5 seconds before reading it.\n--- --Output:\n--- --Delay time was 0.500099\n--- --35\n" - } - ], - "related_commands": [ - "timer.gettime()" - ] - }, - { - "name": "trigger.clear()", - "webhelpfile": "25637.htm", - "signature": "trigger.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function clears any pending command triggers.", - "details": "A command trigger indicates if a trigger event has been detected over a command interface since the last trigger.wait() command was sent. Command triggers are generated by:trigger.clear() clears the command triggers and discards the history of trigger events.", - "param_info": [ - { - "name": "*TRGprint(trigger.wait(1))trigger.clear()print(trigger.wait(1))", - "description": "Generate a trigger event.Check if there are any pending trigger events. Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "*TRG;print(trigger.wait(1));trigger.clear();print(trigger.wait(1));", - "description": "Generate a trigger event.\n--- --Check if there are any pending trigger events. \n--- --Output: true\n--- --Clear any pending command triggers.\n--- --Check if there are any pending trigger events.\n--- --Output: false\n" - } - ], - "related_commands": [ - "trigger.wait()" - ] - }, - { - "name": "trigger.wait()", - "webhelpfile": "25639.htm", - "signature": "trigger.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function waits for a trigger event.", - "details": "This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:If one or more of these trigger events were previously detected, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "A trigger was detected during the timeout period", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger.\n--- --If false is returned, no trigger was detected during the 10\u00a0s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.clear()" - ] - }, - { - "name": "bufferVar.formattedreadings", - "webhelpfile": "25640.htm", - "signature": "bufferVar.formattedreadings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the stored readings shown as numbers with units and prefixes.", - "details": "This read-only attribute is an array that contains the stored readings. The readings are shown as numbers with prefixes before the units symbol.", - "param_info": [ - { - "name": "reading", - "description": "Buffer reading formatted with numbers and prefixes with units for element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.formattedreadings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.formattedreadings[1]);printbuffer(1, testData.n, testData.formattedreadings);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading.\n--- --Example output:\n--- ---0.0001901 V\n--- --Print all readings in the reading buffer.\n--- --Example output:\n--- ---0.0001901 V, +000.08537 mV, -000.13050 mV\n" - } - ], - "related_commands": [ - "bufferVar.readings", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.units", - "webhelpfile": "25641.htm", - "signature": "bufferVar.units[N]", - "command_return": "readingUnit", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "details": "This attribute contains the unit of measure that is stored with readings in the reading buffer.", - "param_info": [ - { - "name": "readingUnit", - "description": "Amp AC", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingUnit = bufferVar.units[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);testData.fillmode = buffer.FILL_CONTINUOUS;dmm.measure.func = dmm.FUNC_DC_CURRENT;trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);dmm.measure.func = dmm.FUNC_DC_VOLTAGE trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData.units);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Set the buffer to fill continuously.\n--- --Set the measure function to current.\n--- --Make three readings.\n--- --Print the units for the readings.\n--- --Output:\n--- --Amp DC, Amp DC, Amp DC\n--- --Set the measure function to voltage.\n--- --Make three readings.\n--- --Output:\n--- --Volt DC, Volt DC, Volt DC\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.saveappend()", - "webhelpfile": "25642.htm", - "signature": "buffer.saveappend(bufferVar, filename, timeFormat, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function appends data from the reading buffer to a file on the USB flash drive.", - "details": "If the file you specify does not exist on the USB flash drive, this command creates the file.For options that save more than one item of time information, each item is comma-delimited. For example, the default format is date, time, and fractional seconds for each reading.The file extension .csv is appended to the file name if necessary. Any file extension other than .csv generates an error.The index column entry in the .csv file starts at 1 for each append operation.Examples of valid destination file names:Invalid destination file name examples:\u2014 The period is not followed by csv.\u2014 The only allowed extension is .csv. If .csv is not assigned, it is automatically added.", - "param_info": [ - { - "name": "bufferVar", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "timeFormat", - "description": "Indicates how date and time information from the buffer is saved in the file on the USB flash drive; the options are", - "enum": "buffer.SAVE_FORMAT_TIME nil|buffer.SAVE_RELATIVE_TIME nil|buffer.SAVE_RAW_TIME nil|buffer.SAVE_TIMESTAMP_TIME nil", - "type": "buffersaveappendtimeFormat", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.saveappend(bufferVar, filename)", - "buffer.saveappend(bufferVar, filename, timeFormat)", - "buffer.saveappend(bufferVar, filename, timeFormat, start, end)" - ], - "overloads": [ - "buffer.saveappend(bufferVar, filename)", - "buffer.saveappend(bufferVar, filename, timeFormat)" - ], - "examples": [ - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myData.csv\");", - "description": "Append reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.saveappend(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Append readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash\u00a0drive.\n" - }, - { - "example": "reset();if file.usbdriveexists() == 1 then; testDir = \"TestData11\";-- Create a directory on the USB drive for the data.; file.mkdir(testDir);-- Build the full file and path.; fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";-- Open the file where the data will be stored.; fileNumber = file.open(fileName, file.MODE_WRITE);-- Write the string data to a file.; file.write(fileNumber, \"Tested to Company Standard ABC.101\\n\");-- Write the header separator to a file.; file.write(fileNumber, \"====================================================================\\n\");-- Write the string data to a file.; file.write(fileNumber, \"\\t1. Connect HI/LO to respective DUT terminals.\\n\"); file.write(fileNumber, \"\\t2. Set power supply to 5 VDC @ 1 A.\\n\"); file.write(fileNumber, \"\\t3. Wait 30 minutes.\\n\"); file.write(fileNumber, \"\\t4. Capture 100 readings and analyze data.\\n\\n\\n\");-- Write buffering data to a file.; file.flush(fileNumber);-- Close the data file.; file.close(fileNumber);end;-- Fix the range to 10 V.;dmm.measure.range = 10.0;-- Set the measurement count to 100.;dmm.measure.count = 100;-- Set up reading buffers.;-- Ensure the default measurement buffer size matches the count.;defbuffer1.capacity = dmm.measure.count;dmm.measure.read();buffer.saveappend(defbuffer1, fileName);", - "description": "Write string data to a file with information about a test file.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.save()" - ] - }, - { - "name": "dmm.measure.configlist.create()", - "webhelpfile": "25691.htm", - "signature": "dmm.measure.configlist.create(listName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function creates an empty measure configuration list.", - "details": "This command creates an empty configuration list. To add configuration indexes to this list, you need to use the store command.Configuration lists are not saved when the instrument is turned off. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "dmm.measure.configlist.create(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.configlist.create(\"MyMeasList\");", - "description": "Create a measure configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "dmm.measure.configlist.catalog()", - "dmm.measure.configlist.delete()", - "dmm.measure.configlist.query()", - "dmm.measure.configlist.recall()", - "dmm.measure.configlist.size()", - "dmm.measure.configlist.store()" - ] - }, - { - "name": "eventlog.save()", - "webhelpfile": "25702.htm", - "signature": "eventlog.save(filename, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves the event log to a file on a USB flash drive.", - "details": "This command saves all event log entries to a USB flash drive.If you do not define an event type, the instrument saves all event log entries.The extension .csv is automatically added to the file name.", - "param_info": [ - { - "name": "filename", - "description": "A string that represents the name of the file to be saved", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsaveeventType", - "range": "" - } - ], - "usage": [ - "eventlog.save(filename)", - "eventlog.save(filename, eventType)" - ], - "overloads": [ - "eventlog.save(filename)" - ], - "examples": [ - { - "example": "eventlog.save(\"/usb1/WarningsApril\", eventlog.SEV_WARN);", - "description": "Save warning messages to a .csv file on a USB flash drive.\n" - } - ], - "related_commands": [ - "eventlog.next()" - ] - }, - { - "name": "bufferVar.capacity", - "webhelpfile": "25706.htm", - "signature": "bufferVar.capacity", - "command_return": "bufferCapacity", - "type": "Attribute (RW)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of readings a buffer can store.", - "details": "This command allows you to change or view how many readings a buffer can store. Changing the size of a buffer will cause any existing data in the buffer to be lost.If you select 0, the instrument creates the largest reading buffer possible based on the available memory when the buffer is created.", - "param_info": [ - { - "name": "bufferCapacity", - "description": "The maximum number of readings the buffer can store; set to 0 to maximize the buffer size (see Details)", - "enum": "", - "type": "integer", - "range": "(see Details)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferCapacity = bufferVar.capacity", - "bufferVar.capacity = bufferCapacity" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(500);capTest = buffer.make(300);bufferCapacity = capTest.capacity;\u00a0;print(bufferCapacity);\u00a0;\u00a0;print(testData.capacity);\u00a0;\u00a0;testData.capacity = 600;print(testData.capacity);print(defbuffer1.capacity);", - "description": "Create two user-defined reading buffers: testData and capTest.\n--- --\u00a0\n--- --Create a variable called bufferCapacity to hold the capacity of the capTest buffer.\n--- --Print bufferCapacity.\n--- --Output:\n--- --300\n--- --Print the capacity of testData.\n--- --Output:\n--- --500\n--- --Changes the capacity of testData to 600.\n--- --Print the capacity of testData.\n--- --Output:\n--- --600\n--- --Print the capacity of the default buffer defbuffer1.\n--- --Output:\n--- --100000\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.relativetimestamps", - "webhelpfile": "25712.htm", - "signature": "bufferVar.relativetimestamps[N]", - "command_return": "timestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamps, in seconds, when each reading occurred, relative to the timestamp of the first entry in the reading buffer.", - "details": "This read-only attribute is an array of timestamps, in seconds, of when each reading occurred relative to the timestamp of the first entry in the reading buffer. These timestamps are equal to the time that has lapsed for each reading since the first reading was stored in the buffer. Therefore, the relative timestamp for the first entry number in the reading buffer equals 0.", - "param_info": [ - { - "name": "timestamp", - "description": "The timestamp, in seconds", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "timestamp = bufferVar.relativetimestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.relativetimestamps[1]);printbuffer(1, 3, testData.relativetimestamps);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --\u00a0\n--- --Print the relative timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0\n--- --Print the relative timestamp for the reading 1 through 3 in the buffer.\n--- --Example output:\n--- --0, 0.383541, 0.772005\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.seconds", - "webhelpfile": "25713.htm", - "signature": "bufferVar.seconds[N]", - "command_return": "nonFracSeconds", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp of a reading in seconds, in UTC format.", - "details": "This attribute contains the nonfractional seconds portion of the timestamp when the reading was stored in Coordinated Universal Time (UTC) format.The nonfractional seconds portion of the timestamp gives the lowest resolution down to 1 second. To access additional resolution of a timestamp, see bufferVar.fractionalseconds.", - "param_info": [ - { - "name": "nonFracSeconds", - "description": "The nonfractional seconds portion of the timestamp when the reading was stored", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "nonFracSeconds = bufferVar.seconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 6, testData.seconds);", - "description": "Create a reading buffer named testData, configure the instrument to make six measurements, and store the readings in the buffer.\n--- --Print the seconds portion for readings 1 to 6 in testData. \n--- --Example output:\n--- --1362261492, 1362261492, 1362261493, 1362261493, 1362261493, 1362261494\n" - } - ], - "related_commands": [ - "bufferVar.fractionalseconds", - "bufferVar.relativetimestamps" - ] - }, - { - "name": "bufferVar.times", - "webhelpfile": "25715.htm", - "signature": "bufferVar.times[N]", - "command_return": "readingTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the time when the instrument made the reading.", - "details": "", - "param_info": [ - { - "name": "readingTime", - "description": "The time of the reading in hours, minutes, and seconds", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTime = bufferVar.times[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.times[1]);printbuffer(1, 3, testData.times);", - "description": "This example creates a reading buffer named testData and makes three measurements.\n--- --The print() command outputs the time of the first reading. \n--- --Output:\n--- --23:09:43\n--- --The printbuffer() command outputs the time of readings 1 to 3 in the reading buffer. \n--- --Output:\n--- --23:09:43, 23:09:43, 23:09:43\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.timestamps", - "webhelpfile": "25716.htm", - "signature": "bufferVar.timestamps[N]", - "command_return": "readingTimestamp", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the timestamp when each reading saved in the specified reading buffer occurred.", - "details": "This attribute contains the timestamps (date, hours, minutes, seconds, and fractional seconds) of readings stored in the reading buffer.", - "param_info": [ - { - "name": "readingTimestamp", - "description": "The complete timestamp (including date, time, and fractional seconds) of reading number N in the specified reading buffer when the reading was acquired", - "enum": "", - "type": "string[]", - "range": "(including date, time, and fractional seconds)" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "readingTimestamp = bufferVar.timestamps[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();print(testData.timestamps[1]);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Output:\n--- --03/01/2018 14:46:07.714614838\n" - }, - { - "example": "for x = 1, 3 do printbuffer(x, x, testData.timestamps) end;", - "description": "For the buffer created in Example 1, print the timestamps for the readings.\n--- --Output:\n--- --03/01/2018 14:46:07.71461483803/01/2018 14:46:08.10046883803/01/2018 14:46:08.487631838\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "display.readingformat", - "webhelpfile": "25719.htm", - "signature": "", - "command_return": "format", - "type": "Attribute (RW)", - "default_value": "display.FORMAT_PREFIX\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the format that is used to display measurement readings on the front-panel display of the instrument.", - "details": "This setting persists through reset() and power cycles.When Prefix is selected, prefixes are added to the units symbol, such as k (kilo) or m (milli). When Exponent is selected, exponents are used instead of prefixes. When the prefix option is selected, very large or very small numbers may be displayed with exponents.", - "param_info": [ - { - "name": "format", - "description": "Use exponent format", - "enum": "display.FORMAT_EXPONENT nil|display.FORMAT_PREFIX nil", - "type": "displayreadingformatformat", - "range": "" - } - ], - "usage": [ - "format = display.readingformat", - "display.readingformat = format" - ], - "overloads": [], - "examples": [ - { - "example": "display.readingformat = display.FORMAT_EXPONENT;", - "description": "Change front-panel display to show readings in exponential format.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.settext()", - "webhelpfile": "25722.htm", - "signature": "display.settext(displayArea, text)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function defines the text that is displayed on the front-panel USER swipe screen.", - "details": "This command defines text messages for the USER swipe screen.If you enter too many characters, the instrument displays a warning event and shortens the message to fit.When the instrument is reset, the user test is removed and the USER swipe screen is hidden until another message is defined.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "displayArea", - "description": "display.TEXT1 display.TEXT2", - "enum": "display.TEXT1 nil|display.TEXT2 nil", - "type": "displaysettextdisplayArea", - "range": "" - }, - { - "name": "text", - "description": "String that contains the message for the top line of the USER swipe screen (up to 20 characters)", - "enum": "", - "type": "string", - "range": "(up to 20 characters)" - } - ], - "usage": [ - "display.settext(displayArea, text)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"A122 \\185 A123\");display.settext(display.TEXT2, \"Results in \\018\");", - "description": "Clear the USER swipe screen.\n--- --Display the USER swipe screen.\n--- --Set the first line to read \"A122 \u0394 A123\" and the second line to display \"\"Results in \u03a9\":\n--- --\n" - } - ], - "related_commands": [ - "display.clear()", - "display.changescreen()" - ] - }, - { - "name": "file.mkdir()", - "webhelpfile": "25723.htm", - "signature": "file.mkdir(path)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a directory at the specified path on the USB flash drive.", - "details": "The directory path must be absolute. The name of the directory must not already exist on the flash drive.", - "param_info": [ - { - "name": "path", - "description": "A string that contains the path of the directory", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.mkdir(path)" - ], - "overloads": [], - "examples": [ - { - "example": "file.mkdir(\"TestData\");", - "description": "Create a new directory named TestData.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.open()", - "webhelpfile": "25724.htm", - "signature": "file.open(fileName, accessType)", - "command_return": "fileNumber", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function opens a file on the USB flash drive for later reference.", - "details": "The path to the file to open must be absolute.If you use file.MODE_APPEND and the file specified to open is not on the flash drive, the file is created.The root folder of the USB flash drive has the following absolute path:", - "param_info": [ - { - "name": "fileNumber", - "description": "A number identifying the open file that you use with other file commands to write, read, flush, or close the file after opening", - "enum": "", - "type": "file_object", - "range": "" - }, - { - "name": "fileName", - "description": "A string that contains the file name to open, including the full path of file", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "accessType", - "description": "The type of action to do", - "enum": "file.MODE_APPEND nil|file.MODE_READ nil|file.MODE_WRITE nil", - "type": "fileopenaccessType", - "range": "" - } - ], - "usage": [ - "fileNumber = file.open(fileName, accessType)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "lan.ipconfig()", - "webhelpfile": "25725.htm", - "signature": "lan.ipconfig()", - "command_return": "method, ipV4Address, subnetMask, gateway", - "type": "Function", - "default_value": "lan.MODE_AUTO\n", - "tsp_link": "No\n", - "description": "This function specifies the LAN configuration for the instrument.", - "details": "This command specifies how the LAN IP address and other LAN settings are assigned. If automatic configuration is selected, the instrument automatically determines the LAN information. When method is automatic, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, an error occurs.If manual is selected, you must define the IP address. You can also assign a subnet mask, and default gateway. The IP address, subnet mask, and default gateway must be formatted in four groups of numbers, each separated by a decimal. If you do not specify a subnet mask or default gateway, the previous settings are used.", - "param_info": [ - { - "name": "method", - "description": "The method for configuring LAN settings; it can be one of the following values", - "enum": "lan.MODE_AUTO nil|lan.MODE_MANUAL nil", - "type": "lanipconfigmethod", - "range": "" - }, - { - "name": "ipV4Address", - "description": "LAN IP address; must be a string specifying the IP address in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "subnetMask", - "description": "The LAN subnet mask; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "gateway", - "description": "The LAN default gateway; must be a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "method, ipV4Address, subnetMask, gateway = lan.ipconfig()", - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "overloads": [ - "lan.ipconfig(method)", - "lan.ipconfig(method, ipV4Address)", - "lan.ipconfig(method, ipV4Address, subnetMask)", - "lan.ipconfig(method, ipV4Address, subnetMask, gateway)" - ], - "examples": [ - { - "example": "lan.ipconfig(lan.MODE_AUTO);print(lan.ipconfig());lan.ipconfig(lan.MODE_MANUAL, \"192.168.0.7\", \"255.255.240.0\", \"192.168.0.3\");print(lan.ipconfig());", - "description": "Set the IP configuration method to automatic. Request the IP configuration. Example output:\n--- --lan.MODE_AUTO 134.63.78.136\u00a0\u00a0 255.255.254.0\u00a0\u00a0 134.63.78.1\n--- --Set the IP configuration method to manual. Request the IP configuration. Output:\n--- --lan.MODE_MANUAL 192.168.0.7\u00a0\u00a0\u00a0 255.255.240.0\u00a0 192.168.0.3\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.settime()", - "webhelpfile": "25726.htm", - "signature": "localnode.settime(year, month, day, hour, minute, second)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the date and time of the instrument.", - "details": "Internally, the instrument bases time in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).When called without a parameter (the first form), the function returns the current time.", - "param_info": [ - { - "name": "year", - "description": "Year; must be more than 1970", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "month", - "description": "Month (1 to 12)", - "enum": "", - "type": "number", - "range": "(1 to 12)" - }, - { - "name": "day", - "description": "Day (1 to 31)", - "enum": "", - "type": "number", - "range": "(1 to 31)" - }, - { - "name": "hour", - "description": "Hour in 24-hour time format (0 to 23)", - "enum": "", - "type": "number", - "range": "(0 to 23)" - }, - { - "name": "minute", - "description": "Minute (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - }, - { - "name": "second", - "description": "Second (0 to 59)", - "enum": "", - "type": "number", - "range": "(0 to 59)" - } - ], - "usage": [ - "localnode.settime()", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "overloads": [ - "localnode.settime()", - "localnode.settime(hour, minute, second)", - "localnode.settime(os.time({year, month, day}))", - "localnode.settime(year, month, day, hour, minute, second)", - "localnode.settime(os.time({year = year, month = month, day = day, hour = hour, min = minute, sec = second}))" - ], - "examples": [ - { - "example": "localnode.settime(2017, 12, 5, 15, 48, 20);print(localnode.settime());", - "description": "Sets the date and time to December 5, 2017 at 3:48:20\u00a0pm and verifies the time.\n--- --Output:\n--- --Tue Dec 5 15:48:20 2017\n" - }, - { - "example": "systemTime = os.time({year = 2018,; month = 3,; day = 31,; hour = 14,; min = 25});localnode.settime(systemTime);print(os.date('%c', gettime()));", - "description": "Sets the date and time to Mar 31, 2018 at 2:25\u00a0pm.\n--- --Output:\n--- --Sat Mar 31 14:25:00 2018\n" - } - ], - "related_commands": [ - "localnode.gettime()" - ] - }, - { - "name": "trigger.model.state()", - "webhelpfile": "25741.htm", - "signature": "trigger.model.state()", - "command_return": "status, status, n", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the present state of the trigger model.", - "details": "This command returns the state of the trigger model. The instrument checks the state of a started trigger model every 100\u00a0ms.This command returns the trigger state and the block that the trigger model last executed.The trigger model states are:", - "param_info": [ - { - "name": "status", - "description": "The status of the trigger model", - "enum": "trigger.STATE_ABORTED nil|trigger.STATE_ABORTING nil|trigger.STATE_BUILDING nil|trigger.STATE_EMPTY nil|trigger.STATE_FAILED nil|trigger.STATE_IDLE nil|trigger.STATE_PAUSED nil|trigger.STATE_RUNNING nil|trigger.STATE_WAITING nil", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "status", - "description": "The status of the parallel/dual trigger model", - "enum": "", - "type": "triggermodelstatestatus", - "range": "" - }, - { - "name": "n", - "description": "The last trigger model block that was executed", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status, status, n = trigger.model.state()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.state());", - "description": "An example output if the trigger model is waiting and is at block 9 would be:\n--- --trigger.STATE_WAITING trigger.STATE_EMPTY 9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "eventlog.clear()", - "webhelpfile": "27637.htm", - "signature": "eventlog.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event log.", - "details": "This command removes all events from the event log, including entries in the front-panel event log.", - "param_info": [], - "usage": [ - "eventlog.clear()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "eventlog.next()", - "eventlog.save()" - ] - }, - { - "name": "eventlog.next()", - "webhelpfile": "27658.htm", - "signature": "eventlog.next(eventType)", - "command_return": "eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the oldest unread event message from the event log.", - "details": "When an event occurs on the instrument, it is placed in the event log. The eventlog.next() command retrieves an unread event from the event log. Once an event is read, it can no longer be accessed remotely. However, it can be viewed on the front panel. When localnode.showevents is enabled, this command never returns an event because those events are automatically read and sent to the remote interface.To read multiple events, execute this command multiple times.If there are no entries in the event log, the following is returned:If the event type is not defined, an event of any type is returned.", - "param_info": [ - { - "name": "eventNumber", - "description": "The event number", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "message", - "description": "A description of the event", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "severity", - "description": "The severity of the event", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "nodeID", - "description": "The TSP-Link node where the event occurred or 0 if the event occurred on the local node", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeSeconds", - "description": "The seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "timeNanoSeconds", - "description": "The fractional seconds portion of the time when the event occurred", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlognexteventType", - "range": "" - } - ], - "usage": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()", - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next(eventType)" - ], - "overloads": [ - " eventNumber, message, severity, nodeID, timeSeconds, timeNanoSeconds = eventlog.next()" - ], - "examples": [ - { - "example": "print(eventlog.next(5));", - "description": "Get the oldest error or information event from the event log.\n--- --Example output:\n--- ---285 TSP Syntax error at line 1: unexpected symbol near `0' 1 0 1367806152 652040060\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.getcount()", - "eventlog.save()" - ] - }, - { - "name": "file.read()", - "webhelpfile": "27929.htm", - "signature": "file.read(fileNumber, readAction)", - "command_return": "fileContents", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function reads data from a file on the USB flash drive.", - "details": "This command reads data from a file.", - "param_info": [ - { - "name": "fileContents", - "description": "The contents of the file based on the readAction parameter", - "enum": "", - "type": "string | nil", - "range": "" - }, - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to read", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "readAction", - "description": "The action", - "enum": "file.READ_LINE nil|file.READ_NUMBER nil|file.READ_ALL nil", - "type": "filereadreadAction", - "range": "" - } - ], - "usage": [ - "fileContents = file.read(fileNumber, readAction)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/testfile.txt\", file.MODE_READ);if file_num != nil then; file_contents = file.read(file_num, file.READ_ALL); file.close(file_num);end;", - "description": "Open testfile.txt on the USB flash drive for reading. If it opens successfully, read the entire contents of the file and store it in variable file_contents.\n--- --Close the file.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.close()", - "webhelpfile": "27930.htm", - "signature": "file.close(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function closes a file on the USB flash drive.", - "details": "Note that files are automatically closed when the file descriptors are garbage collected.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to close", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.close(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"/usb1/GENTRIGGER\", file.MODE_WRITE);file.close(file_num);", - "description": "Open the file GENTRIGGER for writing, then close it.\n" - } - ], - "related_commands": [ - "file.open()" - ] - }, - { - "name": "file.write()", - "webhelpfile": "27934.htm", - "signature": "file.write(fileNumber, string)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes data to a file on the USB flash drive.", - "details": "The file.write() function may include data that is buffering; it may not be written to the USB flash drive immediately. Use the file.flush() function to immediately write buffered data to the drive.You must use the file.close() command to close the file after writing.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to write", - "enum": "", - "type": "file_object", - "range": "()" - }, - { - "name": "string", - "description": "A string that contains the data to write to the file", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "file.write(fileNumber, string)" - ], - "overloads": [], - "examples": [ - { - "example": "file_num = file.open(\"testfile.txt\", file.MODE_WRITE);if file_num != nil then; file.write(file_num, \"This is my test file\"); file.close(file_num);end;", - "description": "Opens file testfile.txt for writing. If no errors were found while opening, writes This is my test file and closes the file.\n" - } - ], - "related_commands": [ - "file.close()", - "file.flush() " - ] - }, - { - "name": "file.flush()", - "webhelpfile": "27958.htm", - "signature": "file.flush(fileNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function writes buffering data to a file on the USB flash drive.", - "details": "The file.write() function may be buffering data instead of writing immediately to the USB flash drive. Use file.flush() to flush this data. Data may be lost if the file is not closed or flushed before a script ends.If there is going to be a time delay before more data is written to a file, flush the file to prevent loss of data because of an aborted test.", - "param_info": [ - { - "name": "fileNumber", - "description": "The file number returned from the file.open() function to flush", - "enum": "", - "type": "file_object", - "range": "()" - } - ], - "usage": [ - "file.flush(fileNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();\u00a0;-- Fix the range to 10 V;dmm.measure.range = 10;\u00a0;-- Set the measurement count to 100;dmm.measure.count = 100;\u00a0;-- Set up reading buffers;-- Ensure the default measurement buffer size matches the count;defbuffer1.capacity = 100;dmm.measure.read();\u00a0;testDir = \"TestData5\";\u00a0;-- create a directory on the USB drive for the data;file.mkdir(testDir);fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\";buffer.save(defbuffer1, fileName);\u00a0;if file.usbdriveexists() != 0 then; -- testDir = \"TestData3\";\u00a0; -- Create a directory on the USB drive for the data; -- file.mkdir(testDir); -- Open the file where the data will be stored; -- fileName = \"/usb1/\" .. testDir .. \"/myTestData.csv\"; fileNumber = file.open(fileName, file.MODE_APPEND);-- Write header separator to file; file.write(fileNumber, \"\\n\\n====================================================================\\n\");-- Write the string data to a file; file.write(fileNumber, \"Tested to Company Standard ABC.123\\n\");-- Ensure a hurry-up of data written to the file before close or script end; file.flush(fileNumber);-- Close the data file; file.close(fileNumber);\u00a0;end;", - "description": "This example writes a string that indicates that the readings were made for a certain reason, such as to test to a company standard.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "format.byteorder", - "webhelpfile": "28048.htm", - "signature": "", - "command_return": "order", - "type": "Attribute (RW)", - "default_value": "format.LITTLEENDIAN\n", - "tsp_link": "No\n", - "description": "This attribute sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions.", - "details": "This attribute selects the byte order in which data is written when you are printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.REAL32 and format.REAL64 data formats.If you are sending data to a computer with a Microsoft Windows operating system, select the format.LITTLEENDIAN byte order.", - "param_info": [ - { - "name": "order", - "description": "Byte order value as follows", - "enum": "format.BIGENDIAN nil|format.LITTLEENDIAN nil", - "type": "formatbyteorderorder", - "range": "" - } - ], - "usage": [ - "order = format.byteorder", - "format.byteorder = order" - ], - "overloads": [], - "examples": [ - { - "example": "x = 1.23;format.data = format.REAL32;format.byteorder = format.LITTLEENDIAN;printnumber(x);format.byteorder = format.BIGENDIAN;printnumber(x);", - "description": "Output depends on the terminal program you use, but will look something like:\n--- --#0\u00a4p??\n--- --#0??p\u00a4\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.data", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.asciiprecision", - "webhelpfile": "28056.htm", - "signature": "", - "command_return": "precision", - "type": "Attribute (RW)", - "default_value": "0 (Automatic)\n", - "tsp_link": "No\n", - "description": "This attribute sets the precision (number of digits) for all numbers returned in the ASCII format.", - "details": "This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number from 0 to 16.Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.", - "param_info": [ - { - "name": "precision", - "description": "A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number from 1 to 16; set to 0 to have the instrument select the precision automatically based on the number that is being formatted", - "enum": "", - "type": "number", - "range": "()" - } - ], - "usage": [ - "precision = format.asciiprecision", - "format.asciiprecision = precision" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 2.54;printnumber(x);format.asciiprecision = 3;printnumber(x);", - "description": "Output:\n--- --2.540000000e+00\n--- --\u00a0\n--- --2.54e+00\n" - } - ], - "related_commands": [ - "format.byteorder", - "format.data", - "print()", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "format.data", - "webhelpfile": "28063.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "format.ASCII\n", - "tsp_link": "No\n", - "description": "This attribute sets the data format for data that is printed using the printnumber() and printbuffer() functions.", - "details": "You can control the precision of numeric values with the format.asciiprecision attribute. If format.REAL32 or format.REAL64 is selected, you can select the byte order with the format.byteorder attribute.The IEEE Std 754 binary formats use four bytes for single-precision values and eight bytes for double-precision values.When data is written with any of the binary formats, the response message starts with #0 and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.", - "param_info": [ - { - "name": "value", - "description": "The format to use for data, set to one of the following values", - "enum": "format.ASCII nil|format.REAL32 nil|format.REAL64 nil", - "type": "formatdatavalue", - "range": "" - } - ], - "usage": [ - "value = format.data", - "format.data = value" - ], - "overloads": [], - "examples": [ - { - "example": "format.asciiprecision = 10;x = 3.14159265;format.data = format.ASCII;printnumber(x);format.data = format.REAL64;printnumber(x);", - "description": "Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.\n--- --Output:\n--- --3.141592650e+00\n--- --#0\u00f1\u00d4\u00c8S\u00fb! @\n" - } - ], - "related_commands": [ - "format.asciiprecision", - "format.byteorder", - "printbuffer()", - "printnumber()" - ] - }, - { - "name": "trigger.lanin[N].edge", - "webhelpfile": "28111.htm", - "signature": "", - "command_return": "edgeMode", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_EITHER\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the trigger operation and detection mode of the specified LAN event.", - "details": "This command controls how the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.", - "param_info": [ - { - "name": "edgeMode", - "description": "The trigger mode; see the Details for more information", - "enum": "", - "type": "triggerMode", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "edgeMode = trigger.lanin[N].edge", - "trigger.lanin[N].edge = edgeMode" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[1].edge = trigger.EDGE_FALLING;", - "description": "Set the edge state of LAN event 1 to falling.\n" - } - ], - "related_commands": [ - "Digital I/O", - "TSP-Link system expansion interface" - ] - }, - { - "name": "dmm.measure.configlist.catalog()", - "webhelpfile": "28417.htm", - "signature": "dmm.measure.configlist.catalog()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the name of one measure configuration list that is stored on the instrument.", - "details": "You can use this command to retrieve the names of measure configuration lists that are stored in the instrument. This command returns one name each time you send it. This command returns nil to indicate that there are no more names to return. If the command returns nil the first time you send it, no measure configuration lists have been created for the instrument.", - "param_info": [ - { - "name": "output", - "description": "Returns the name of one measure configuration list that is stored on the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = dmm.measure.configlist.catalog()" - ], - "overloads": [], - "examples": [ - { - "example": "print(dmm.measure.configlist.catalog());", - "description": "Request the name of one measure configuration list that is stored in the instrument. Send the command again until it returns nil to get all stored lists.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "dmm.measure.configlist.create()" - ] - }, - { - "name": "dmm.measure.configlist.query()", - "webhelpfile": "28418.htm", - "signature": "dmm.measure.configlist.query(listName, index, fieldSeparator)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.", - "details": "This command recalls data for one configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "fieldSeparator", - "description": "String that represents the separator for the data; use one of the following", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "output", - "description": "Returns a list of TSP commands and parameter settings that are stored in the specified configuration index", - "enum": "", - "type": "string[]", - "range": "" - } - ], - "usage": [ - "output = dmm.measure.configlist.query(listName, index)", - "output = dmm.measure.configlist.query(listName, index, fieldSeparator)" - ], - "overloads": [ - "output = dmm.measure.configlist.query(listName, index)" - ], - "examples": [ - { - "example": "print(dmm.measure.configlist.query(\"testMeasList\", 2, \"\\n\"));", - "description": "Returns the TSP commands and parameter settings that represent the settings in configuration index 2.\n--- --Partial example output:\n--- --dmm.measure.func = dmm.FUNC_DC_VOLTAGE\n--- --dmm.measure.unit = dmm.UNIT_VOLT\n--- --dmm.measure.range = 0.1\n--- --dmm.measure.autorange = dmm.ON\n--- --dmm.measure.transducer is not used\n--- --dmm.measure.detectorbandwidth is not used\n--- --dmm.measure.autozero.enable = dmm.ON\n--- --dmm.measure.autodelay = dmm.DELAY_ON\n--- --dmm.measure.displaydigits = dmm.DIGITS_6_5\n--- --dmm.measure.dbreference = 1\n--- --dmm.measure.filter.enable = dmm.OFF\n--- --dmm.measure.filter.count = 10\n--- --dmm.measure.filter.type = dmm.FILTER_REPEAT_AVG\n--- --dmm.measure.filter.window = 0\n" - } - ], - "related_commands": [ - "createconfigscript()", - "dmm.measure.configlist.create()" - ] - }, - { - "name": "dmm.measure.configlist.recall()", - "webhelpfile": "28419.htm", - "signature": "dmm.measure.configlist.recall(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function recalls a configuration index in a measure configuration list.", - "details": "Use this command to recall the settings stored in a specific configuration index in a measure configuration list. If you do not specify an index when you send the command, it recalls the settings stored in the first configuration index in the specified measure configuration list. If you recall an invalid index (for example, calling index 3 when there are only two indexes in the configuration list) or try to recall an index from an empty configuration list, an error message is displayed.Each index contains the settings for the selected function of that index. Settings for other functions are not affected when the configuration list index is recalled. A single index stores the settings associated with a single measure or digitize function.This command recalls data for one configuration index.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the measure configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "dmm.measure.configlist.recall(listName)", - "dmm.measure.configlist.recall(listName, index)" - ], - "overloads": [ - "dmm.measure.configlist.recall(listName)" - ], - "examples": [ - { - "example": "dmm.measure.configlist.recall(\"MyMeasList\");", - "description": "Because an index was not specified, this command recalls configuration index 1 from a configuration list named MyMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "dmm.measure.configlist.create()", - "dmm.measure.configlist.store()" - ] - }, - { - "name": "dmm.measure.configlist.delete()", - "webhelpfile": "28421.htm", - "signature": "dmm.measure.configlist.delete(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a measure configuration list.", - "details": "Deletes a configuration list. If the index is not specified, the entire configuration list is deleted. If the index is specified, only the specified configuration index in the list is deleted.When an index is deleted from a configuration list, the index numbers of the following indexes are shifted up by one. For example, if you have a configuration list with 10 indexes and you delete index 3, the index that was numbered 4 becomes index 3, and the all the following indexes are renumbered in sequence to index 9. Because of this, if you want to delete several nonconsecutive indexes in a configuration list, it is best to delete the higher numbered index first, then the next lower index, and so on. This also means that if you want to delete all the indexes in a configuration list, you must delete index 1 repeatedly until all indexes have been removed.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "dmm.measure.configlist.delete(listName)", - "dmm.measure.configlist.delete(listName, index)" - ], - "overloads": [ - "dmm.measure.configlist.delete(listName)" - ], - "examples": [ - { - "example": "dmm.measure.configlist.delete(\"myMeasList\");", - "description": "Delete a measure configuration list named myMeasList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "dmm.measure.configlist.create()" - ] - }, - { - "name": "lan.macaddress", - "webhelpfile": "28423.htm", - "signature": "", - "command_return": "MACaddress", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "No\n", - "description": "This attribute describes the LAN MAC address.", - "details": "The MAC address is a character string representing the MAC address of the instrument in hexadecimal notation. The string includes colons that separate the address octets.", - "param_info": [ - { - "name": "MACaddress", - "description": "The MAC address of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "MACaddress = lan.macaddress" - ], - "overloads": [], - "examples": [ - { - "example": "print(lan.macaddress);", - "description": "Returns the MAC address. For example:\n--- --08:00:11:00:00:57\n" - } - ], - "related_commands": [ - "lan.ipconfig()" - ] - }, - { - "name": "dmm.measure.autozero.once()", - "webhelpfile": "29049.htm", - "signature": "dmm.measure.autozero.once()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to refresh the reference and zero measurements once.", - "details": "This command forces a refresh of the reference and zero measurements that are used for the present aperture setting for the selected function.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.If the NPLC setting is less than 0.2\u00a0PLC, sending autozero once can result in delay of more than a second.", - "param_info": [ - { - "name": "dmm.FUNC_DC_VOLTAGE", - "description": "dmm.FUNC_RESISTANCE\ndmm.FUNC_ACV_FREQUENCY", - "enum": "dmm.FUNC_RESISTANCE nil|dmm.FUNC_ACV_FREQUENCY nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_AC_VOLTAGE", - "description": "dmm.FUNC_4W_RESISTANCE\ndmm.FUNC_ACV_PERIOD", - "enum": "dmm.FUNC_4W_RESISTANCE nil|dmm.FUNC_ACV_PERIOD nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_DC_CURRENT", - "description": "dmm.FUNC_DIODE\ndmm.FUNC_DCV_RATIO", - "enum": "dmm.FUNC_DIODE nil|dmm.FUNC_DCV_RATIO nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_AC_CURRENT", - "description": "dmm.FUNC_CAPACITANCE\ndmm.FUNC_DIGITIZE_CURRENT", - "enum": "dmm.FUNC_CAPACITANCE nil|dmm.FUNC_DIGITIZE_CURRENT nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_TEMPERATURE", - "description": "dmm.FUNC_CONTINUITY\ndmm.FUNC_DIGITIZE_VOLTAGE", - "enum": "dmm.FUNC_CONTINUITY nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.measure.autozero.once()" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.autozero.once();", - "description": "Do a one-time refresh of the reference and zero measurements.\n" - } - ], - "related_commands": [ - "dmm.measure.autozero.enable" - ] - }, - { - "name": "beeper.beep()", - "webhelpfile": "29636.htm", - "signature": "beeper.beep(duration, frequency)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function generates an audible tone.", - "details": "You can use the beeper of the instrument to provide an audible signal at a specific frequency and time duration.Using this function from a remote interface does not affect audible errors or key click settings that were made from the DMM7510 front panel.", - "param_info": [ - { - "name": "duration", - "description": "The amount of time to play the tone (0.001\u00a0s to 100\u00a0s)", - "enum": "", - "type": "number", - "range": "(0.001\u00a0s to 100\u00a0s)" - }, - { - "name": "frequency", - "description": "The frequency of the beep (20\u00a0Hz to 8000 Hz)", - "enum": "", - "type": "number", - "range": "(20\u00a0Hz to 8000 Hz)" - } - ], - "usage": [ - "beeper.beep(duration, frequency)" - ], - "overloads": [], - "examples": [ - { - "example": "beeper.beep(2, 2400);", - "description": "Generates a 2 s, 2400\u00a0Hz tone.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "opc()", - "webhelpfile": "29846.htm", - "signature": "opc()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the operation complete (OPC) bit after all pending commands, including overlapped commands, have been executed.", - "details": "This function causes the operation complete bit in the Status Event Status Register to be set when all previously started local overlapped commands are complete. Note that each node independently sets its operation complete bits in its own status model. Any nodes that are not actively performing overlapped commands set their bits immediately. All remaining nodes set their own bits as they complete their own overlapped commands.", - "param_info": [ - { - "name": "opc()waitcomplete()print(\"1\")", - "description": "Output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "opc()" - ], - "overloads": [], - "examples": [ - { - "example": "opc();waitcomplete();print(\"1\");", - "description": "Output:\n--- --1\n" - } - ], - "related_commands": [ - "waitcomplete()" - ] - }, - { - "name": "bufferVar.clear()", - "webhelpfile": "30485.htm", - "signature": "bufferVar.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears all readings and statistics from the specified buffer.", - "details": "", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);testData.clear();print(\"Readings in buffer after clear =\" .. testData.n);trigger.model.initiate();waitcomplete();printbuffer(1, testData.n, testData);", - "description": "Create a reading buffer named testData, make three readings and store them in testData, and then view the readings.\n--- --Print number of readings in testData.\n--- --Output:\n--- ---4.5010112303956e-10, -3.9923108222095e-12, -4.5013931471161e-10\n--- --Clear the readings in testData.\n--- --Verify that there are no readings in testData.\n--- --Output:\n--- --Readings in buffer after clear = 0\n--- --Store three new readings in testData and view those when complete.\n--- --Output:\n--- --4.923509754e-07, 3.332266330e-07, 3.974883867e-07\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.dates", - "webhelpfile": "30488.htm", - "signature": "bufferVar.dates[N]", - "command_return": "date", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the dates of readings that are stored in the reading buffer.", - "details": "The dates are formatted as month, day, year.This is not available if the reading buffer style is set to compact.", - "param_info": [ - { - "name": "date", - "description": "The date of readings stored in bufferVar element N", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "date = bufferVar.dates[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 1, testData);trigger.model.initiate();waitcomplete();print(testData.dates[1]);printbuffer(1, testData.n, testData.dates);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the first reading date. \n--- --Example output:\n--- --11/27/2017\n--- --Prints the dates for readings 1 through the last reading in the buffer.\n--- --Example output:\n--- --11/27/2017, 11/27/2017, 11/27/2017\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.fillmode", - "webhelpfile": "30489.htm", - "signature": "bufferVar.fillmode", - "command_return": "fillMode", - "type": "Attribute (RW)", - "default_value": "User-defined buffer: buffer.FILL_ONCE (0)defbuffer1: buffer.FILL_CONTINUOUS (1)defbuffer2: buffer.FILL_CONTINUOUS (1)\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if a reading buffer is filled continuously or is filled once and stops.", - "details": "When a reading buffer is set to fill once, no data is overwritten in the buffer. When the buffer is filled, no more data is stored in that buffer and new readings are discarded.When a reading buffer is set to fill continuously, the oldest data is overwritten by the newest data after the buffer fills.When you change the fill mode of a buffer, any data in the buffer is cleared.", - "param_info": [ - { - "name": "fillMode", - "description": "Fill the buffer, then stop", - "enum": "buffer.FILL_ONCE nil|buffer.FILL_CONTINUOUS nil", - "type": "bufferVarfillmodefillMode", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "fillMode = bufferVar.fillmode", - "bufferVar.fillmode = fillMode" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);print(testData.fillmode);testData.fillmode = buffer.FILL_CONTINUOUS;print(testData.fillmode);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer. Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --0\n--- --Set fill mode to continuous. \n--- --Print the fill mode setting for the testData buffer.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "trigger.digout[N].stimulus", - "webhelpfile": "30501.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the digital output line.", - "details": "The digital trigger pulsewidth command determines how long the trigger is asserted.The trigger stimulus for a digital I/O line can be set to one of the trigger events that are described in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "event = trigger.digout[N].stimulus", - "trigger.digout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].stimulus = trigger.EVENT_TIMER3;", - "description": "Set the stimulus for output digital trigger line 2 to be the expiration of trigger timer 3.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()", - "trigger.digout[N].assert()" - ] - }, - { - "name": "display.clear()", - "webhelpfile": "30502.htm", - "signature": "display.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the text from the front-panel USER swipe screen.", - "details": "", - "param_info": [ - { - "name": "display.clear()display.changescreen(display.SCREEN_USER_SWIPE)display.settext(display.TEXT1, \"Serial number:\")display.settext(display.TEXT2, localnode.serialno)", - "description": "Clear the USER swipe screen.Set the first line to read \"Serial number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "display.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.changescreen(display.SCREEN_USER_SWIPE);display.settext(display.TEXT1, \"Serial number:\");display.settext(display.TEXT2, localnode.serialno);", - "description": "Clear the USER swipe screen.\n--- --Set the first line to read \"Serial number:\" and the second line to display the serial number of the instrument.\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "display.changescreen()", - "webhelpfile": "30503.htm", - "signature": "display.changescreen(screenName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function changes which front-panel screen is displayed.", - "details": "", - "param_info": [ - { - "name": "screenName", - "description": "The screen to display", - "enum": "display.SCREEN_HOME nil|display.SCREEN_HOME_LARGE_READING nil|display.SCREEN_READING_TABLE nil|display.SCREEN_GRAPH nil|display.SCREEN_HISTOGRAM nil|display.SCREEN_FUNCTIONS_SWIPE nil|display.SCREEN_GRAPH_SWIPE nil|display.SCREEN_SECONDARY_SWIPE nil|display.SCREEN_SETTINGS_SWIPE nil|display.SCREEN_STATS_SWIPE nil|display.SCREEN_USER_SWIPE nil|display.SCREEN_PROCESSING nil", - "type": "displaychangescreenscreenName", - "range": "" - } - ], - "usage": [ - "display.changescreen(screenName)" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT1, \"Batch A122\");display.settext(display.TEXT2, \"Test running\");display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clear the USER swipe screen.\n--- --Set the first line of the USER swipe screen to read \"Batch A122\" and the second line to display \"Test running\".\n--- --Display the USER swipe screen.\n--- --\n" - } - ], - "related_commands": [ - "display.settext()" - ] - }, - { - "name": "localnode.showevents", - "webhelpfile": "30504.htm", - "signature": "", - "command_return": "errorMode", - "type": "Attribute (RW)", - "default_value": "0 (no events sent)\n", - "tsp_link": "No\n", - "description": "This attribute sets whether or not the instrument automatically outputs generated events to the remote interface.", - "details": "Enable this attribute to have the instrument output generated events to the remote interface.Events are output after a command message is executed but before prompts are issued (if prompts are enabled with localnode.prompts).If this attribute is disabled, use eventlog.next() to retrieve unread events from the event log.Events are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable show events when the GPIB connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "errorMode", - "description": "The errors that are returned", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "localnodeshoweventserrorMode", - "range": "" - } - ], - "usage": [ - "errorMode = localnode.showevents", - "localnode.showevents = errorMode" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.showevents = eventlog.SEV_ERROR | eventlog.SEV_INFO;trigger.digin[3].edge = trigger.EDGE_EITHER;", - "description": "Send generated error and warning messages.\n--- --Example output if the edge cannot be sent to either:\n--- --1805, Settings conflict: setting input edge when line 3 set for digital\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "localnode.prompts" - ] - }, - { - "name": "status.operation.getmap()", - "webhelpfile": "30523.htm", - "signature": "status.operation.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Operation Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "setEvent, clearEvent = status.operation.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.getmap(0));", - "description": "Query bit 0 of the Operation Event Register.\n--- --Example output:\n--- --4918 4917\n" - } - ], - "related_commands": [ - "Operation Event Register", - "Programmable status register sets", - "status.operation.setmap()" - ] - }, - { - "name": "status.questionable.event", - "webhelpfile": "30524.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Event Register.", - "details": "This query reads the contents of the questionable status event register. After sending this command and addressing the instrument to talk, a value is sent to the computer. This value indicates which bits in the appropriate register are set.The Questionable Register can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set the Questionable Register to the sum of their decimal weights. For example, to set bits B12 and B13, set the Questionable Register to 12,288 (which is the sum of 4,096\u00a0+\u00a08,192).", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the questionable status register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.event" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 66 = binary 0100 0010;questionableRegister = 66;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B1 and B6 of the status questionable enable register.\n" - }, - { - "example": "-- decimal 2560 = binary 00001010 0000 0000;questionableRegister = 2560;status.questionable.enable = questionableRegister;", - "description": "Uses a decimal value to set bits B9 and B11 of the status questionable enable register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.standard.enable", - "webhelpfile": "30525.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or sets the bits in the Status Enable register of the Standard Event Register.", - "details": "When a bit in the Status Enable register is set on and the corresponding bit in the Standard Event Status register is set on, the ESB bit of the Status Byte Register is set to on.To set a bit on, send the constant or value of the bit as the standardRegister parameter.You can set the bit as a constant or a numeric value, as shown in the table below. To set more than one bit of the register, you can send multiple constants with + between them. You can also set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B2, set standardRegister to 5 (which is the sum of 1 + 4). You can also send:status.standard.enable = status.standard.OPC + status.standard.QYEWhen zero (0) is returned, no bits are set. You can also send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The value of the Status Enable register of the Standard Event Register (0 to 255)", - "enum": "", - "type": "number", - "range": "(0 to 255)" - } - ], - "usage": [ - "standardRegister = status.standard.enable", - "status.standard.enable = standardRegister" - ], - "overloads": [], - "examples": [ - { - "example": "standardRegister = status.standard.OPC + status.standard.QYE;status.standard.enable = standardRegister;", - "description": "Uses constants to set the OPC and QYE bits of the standard event status enable register.\n" - }, - { - "example": "-- decimal 5 = binary 0000 0101;standardRegister = 5;status.standard.enable = standardRegister;", - "description": "Uses a decimal value to set the OPC and QYE bits of the standard event status enable register.\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "trigger.timer[N].start.generate", - "webhelpfile": "30536.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies when timer events are generated.", - "details": "When this is set to on, a trigger event is generated immediately when the timer is triggered.When it is set to off, a trigger event is generated when the timer elapses. This generates the event trigger.EVENT_TIMERN.", - "param_info": [ - { - "name": "state", - "description": "Generate a timer event when the timer delay elapses", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerstartgeneratestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.generate", - "trigger.timer[N].start.generate = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[4].reset();trigger.timer[4].delay = 0.5;trigger.timer[4].start.stimulus = trigger.EVENT_NOTIFY8;trigger.timer[4].start.generate = trigger.OFF;trigger.timer[4].count = 20;trigger.timer[4].enable = trigger.ON;", - "description": "Reset trigger timer 4.\n--- --Set trigger timer 4 to have a 0.5 s delay.\n--- --Set the stimulus for trigger timer 4 to be the notify 8 event.\n--- --Set the timer event to occur when the timer delay elapses.\n--- --Set the trigger timer 4 count to 20.\n--- --Enable trigger timer 4.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "bufferVar.fractionalseconds", - "webhelpfile": "30542.htm", - "signature": "bufferVar.fractionalseconds[N]", - "command_return": "fractionalSec", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the fractional second portion of the timestamp of each reading in the reading buffer.", - "details": "This read-only attribute is an array of the fractional portion of the timestamp, in seconds, when each reading occurred. Seconds are shown as fractions.", - "param_info": [ - { - "name": "fractionalSec", - "description": "The fractional second portion of the timestamp to 1\u00a0ns resolution", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "fractionalSec = bufferVar.fractionalseconds[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 6, 0, testData);trigger.model.initiate();waitcomplete();print(testData.fractionalseconds[1]);printbuffer(1, 6, testData.fractionalseconds);", - "description": "Create a reading buffer named testData and make six measurements.\n--- --Print the fractional portion of the timestamp for the first reading in the buffer.\n--- --Example output:\n--- --0.647118937\n--- --Print the fractional portion of the timestamp for the first six readings in the buffer.\n--- --Example output:\n--- --0.647118937, 0.064543, 0.48196127, 0.89938724, 0.316800064, 0.734218263\n" - } - ], - "related_commands": [ - "bufferVar.seconds", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.readings", - "webhelpfile": "30545.htm", - "signature": "bufferVar.readings[N]", - "command_return": "reading", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the readings stored in a specified reading buffer.", - "details": "", - "param_info": [ - { - "name": "reading", - "description": "The value of the reading in the specified reading buffer", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "reading = bufferVar.readings[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 3, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 3, testData.readings);", - "description": "Create a reading buffer named testData, configure the instrument to make three measurements, and store the readings in the buffer.\n--- --Print the three readings in testData.\n--- --Output:\n--- ---9.6420389034124e-12, -4.5509945811872e-10, -9.1078204006445e-12\n" - } - ], - "related_commands": [ - "bufferVar.n", - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "tsplink.initialize()", - "webhelpfile": "30551.htm", - "signature": "tsplink.initialize(expectedNodes)", - "command_return": "nodesFound", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function initializes all instruments and enclosures in the TSP-Link system.", - "details": "If the only node on the TSP-Link network is the one running the command and expectedNodes is not provided, this function generates an error event. If you set expectedNodes to 1, the node is initialized.If you include expectedNodes, if nodesFound is less than expectedNodes, an error event is generated.", - "param_info": [ - { - "name": "nodesFound", - "description": "The number of nodes found on the system, including the node on which the command is running", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "expectedNodes", - "description": "The number of nodes expected on the system (1 to 32)", - "enum": "", - "type": "integer", - "range": "(1 to 32)" - } - ], - "usage": [ - "nodesFound = tsplink.initialize()", - "nodesFound = tsplink.initialize(expectedNodes)" - ], - "overloads": [ - "nodesFound = tsplink.initialize()" - ], - "examples": [ - { - "example": "nodesFound = tsplink.initialize(2);print(\"Nodes found = \" .. nodesFound);", - "description": "Perform a TSP-Link initialization and indicate how many nodes are found.\n--- --Example output if two nodes are found:Nodes found = 2\n--- --Example output if fewer nodes are found and if localnode.showevents = 7:1219, TSP-Link found fewer nodes than expectedNodes found = 1\n" - } - ], - "related_commands": [ - "Initializing the TSP-Link system", - "localnode.showevents", - "tsplink.node", - "tsplink.state" - ] - }, - { - "name": "eventlog.getcount()", - "webhelpfile": "30552.htm", - "signature": "eventlog.getcount(eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the number of unread events in the event log.", - "details": "A count finds the number of unread events in the event log. You can specify the event types to return or return the count for all events.This command reports the number of events that have occurred since the command was last sent or since the event log was last cleared.Events are read automatically when localnode.showevents is enabled. You can also read them individually with eventlog.next().", - "param_info": [ - { - "name": "eventType", - "description": "Limits the return to specific event log types; set a cumulative integer value that represents the event log types to", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventloggetcounteventType", - "range": "" - } - ], - "usage": [ - "eventlog.getcount()", - "eventlog.getcount(eventType)" - ], - "overloads": [ - "eventlog.getcount()" - ], - "examples": [ - { - "example": "print(eventlog.getcount(eventlog.SEV_INFO));", - "description": "Displays the present number of unread information messages in the instrument event log.\n--- --If there are three information messages in the event log, output is:\n--- --3\n" - } - ], - "related_commands": [ - "eventlog.clear()", - "eventlog.next()", - "localnode.showevents" - ] - }, - { - "name": "trigger.timer[N].start.overrun", - "webhelpfile": "30553.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if an event was ignored because of the event detector state.", - "details": "This command indicates if an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.", - "param_info": [ - { - "name": "state", - "description": "The trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].start.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.timer[1].start.overrun);", - "description": "If an event was ignored, the output is true.\n--- --If the event was not ignored, the output is false.\n" - } - ], - "related_commands": [ - "trigger.timer[N].reset()" - ] - }, - { - "name": "trigger.timer[N].start.stimulus", - "webhelpfile": "30555.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the event that starts the trigger timer.", - "details": "Set the stimulus to any trigger event to start the timer when that event occurs.Set the stimulus to none to disable event processing and use the timer as a timer or alarm based on the start time.Trigger events are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event that starts the trigger timer; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.timer[N].start.stimulus", - "trigger.timer[N].start.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;trigger.timer[1].delay = 3e-3;trigger.timer[1].start.stimulus = trigger.EVENT_DIGIO3;", - "description": "Set digital I/O line 3 to be a trigger input.\n--- --Set timer 1 to delay for 3\u00a0ms.\n--- --Set timer 1 to start the timer when an event is detected on digital I/O line 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dmm.measure.configlist.store()", - "webhelpfile": "30559.htm", - "signature": "dmm.measure.configlist.store(listName, index)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function stores the active measure or digitize settings into the named configuration list.", - "details": "Use this command to store the active measure or digitize settings to a configuration index in a configuration list. If the index parameter is not provided, the new settings are appended to the end of the list. The index only stores the active settings for a single active measure or digitize function.A measure configuration list can store measure or digitize settings, but not at the same time. If the active function is a digitize function, digitize settings are saved. When the index is queried, digitize settings and their values are listed, but measure settings are listed as not being used. Similarly, if the active function is a measure function, measure settings are saved. When the index is queried, the measure settings and their values are listed, but the digitize settings are listed as not used.Configuration lists are not saved when the instrument is turned off or reset. To save a configuration list, create a configuration script to save instrument settings, including any defined configuration lists.", - "param_info": [ - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "A number that defines a specific configuration index in the configuration list", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "dmm.measure.configlist.store(listName)", - "dmm.measure.configlist.store(listName, index)" - ], - "overloads": [ - "dmm.measure.configlist.store(listName)" - ], - "examples": [ - { - "example": "dmm.measure.configlist.store(\"MyConfigList\");", - "description": "Stores the active settings of the instrument to the end of the configuration list MyConfigList.\n" - } - ], - "related_commands": [ - "createconfigscript()", - "dmm.measure.configlist.create()" - ] - }, - { - "name": "status.clear()", - "webhelpfile": "30567.htm", - "signature": "status.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears event registers.", - "details": "This command clears the event registers of the Questionable Event and Operation Event Register set. It does not affect the Questionable Event Enable or Operation Event Enable registers.", - "param_info": [ - { - "name": "status.clear()", - "description": "Clear the bits in the registers", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "status.clear();", - "description": "Clear the bits in the registers\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.getblocklist()", - "webhelpfile": "30569.htm", - "signature": "trigger.model.getblocklist()", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the settings for all trigger model blocks.", - "details": "This returns the settings for the trigger model.", - "param_info": [ - { - "name": "output", - "description": "Returns the settings for the trigger model", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getblocklist()" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.model.getblocklist());", - "description": "Returns the settings for the trigger model. Example output is:\n--- -- 1) BUFFER_CLEAR BUFFER: defbuffer1\n--- -- 2) MEASURE_DIGITIZE BUFFER: defbuffer1 INITIAL MODE: MEAS INITIAL COUNT: 1\n--- -- 3) BRANCH_COUNTER VALUE: 5 BRANCH_BLOCK: 2\n--- -- 4) DELAY_CONSTANT DELAY: 1.000000000\n--- -- 5) BRANCH_COUNTER VALUE: 3 BRANCH_BLOCK: 2\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()" - ] - }, - { - "name": "trigger.model.getbranchcount()", - "webhelpfile": "30570.htm", - "signature": "trigger.model.getbranchcount(blockNumber)", - "command_return": "output", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the count value of the trigger model counter block.", - "details": "This command returns the counter value. When the counter is active, this returns the present count. If the trigger model has started or is running but has not yet reached the counter block, this value is 0.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "output", - "description": "Returns the count value of the trigger model counter block.", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "output = trigger.model.getbranchcount(blockNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 0.1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);trigger.model.initiate();delay(1);print(trigger.model.getbranchcount(4));waitcomplete();", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and make five readings.\n--- --Delay 0.1 s.\n--- --Loop ten more times back to block 2.\n--- --Send the count command to check which count has been completed for block 4.\n--- --At end of execution, 10 readings are stored in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "trigger.model.initiate()", - "webhelpfile": "30571.htm", - "signature": "trigger.model.initiate()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function starts the trigger model.", - "details": "", - "param_info": [], - "usage": [ - "trigger.model.initiate()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.model.abort()" - ] - }, - { - "name": " trigger.BLOCK_BUFFER_CLEAR", - "webhelpfile": "30574.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that clears the reading buffer.", - "details": "When trigger model execution reaches the buffer clear trigger block, the instrument empties the specified reading buffer. The specified buffer can be the default buffer or a buffer that you defined.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR, bufferName)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BUFFER_CLEAR)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_BUFFER_CLEAR, capTest2);", - "description": "Assign trigger block 3 to buffer clear; when the trigger model reaches block 3, it clears the reading buffer named capTest2.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Buffer clear block" - ] - }, - { - "name": "trigger.timer[N].enable", - "webhelpfile": "30576.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "trigger.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables the trigger timer.", - "details": "When this command is set to on, the timer performs the delay operation.When this command is set to off, there is no timer on the delay operation.You must enable a timer before it can use the delay settings or the alarm configuration. For expected results from the timer, it is best to disable the timer before changing a timer setting, such as delay or start seconds.To use the timer as a simple delay or pulse generator with digital I/O lines, make sure the timer start time in seconds and fractional seconds is configured for a time in the past. To use the timer as an alarm, configure the timer start time in seconds and fractional seconds for the desired alarm time.", - "param_info": [ - { - "name": "state", - "description": "Disable the trigger timer", - "enum": "trigger.OFF nil|trigger.ON nil", - "type": "triggertimerenablestate", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "state = trigger.timer[N].enable", - "trigger.timer[N].enable = state" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[3].enable = trigger.ON;", - "description": "Enable the trigger timer for timer 3.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "bufferVar.logstate", - "webhelpfile": "30577.htm", - "signature": "bufferVar.logstate", - "command_return": "logState", - "type": "Attribute (RW)", - "default_value": "defbuffer1: buffer.ON (1)defbuffer2: buffer.ON (1)User-created buffer: buffer.OFF (0)\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if information events are logged when the specified reading buffer is at 0% or 100% filled.", - "details": "If this is set to on, when the reading buffer is cleared (0% filled) or full (100% filled), an event is logged in the event log. If this is set to off, reading buffer status is not reported in the event log.", - "param_info": [ - { - "name": "logState", - "description": "Do not log information events", - "enum": "buffer.OFF nil|buffer.ON nil", - "type": "bufferVarlogstatelogState", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "logState = bufferVar.logstate", - "bufferVar.logstate = logState" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;MyBuffer = buffer.make(500);print(MyBuffer.logstate);", - "description": "Create the user-defined buffer MyBuffer.\n--- --Print the log state of MyBuffer.\n--- --Output:\n--- --0\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - DurationLoop", - "webhelpfile": "30588.htm", - "signature": "trigger.model.load(DurationLoop, duration, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements for a specified amount of time.", - "details": "When you load this trigger-model template, you can specify amount of time to make a measurement and the length of the delay before the measurement.The out line of the EXT TRIG IN/OUT rear-panel terminal is asserted at the end of each measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "DurationLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "duration", - "description": "The amount of time for which to make measurements (500 ns to 100\u00a0ks)", - "enum": "", - "type": "number", - "range": "(500 ns to 100\u00a0ks)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)", - "trigger.model.load(DurationLoop, duration, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(DurationLoop, duration)", - "trigger.model.load(DurationLoop, duration, delay)" - ], - "examples": [ - { - "example": "reset();-- Set up measure function;dmm.measure.func = dmm.FUNC_DC_CURRENT;-- Initiate readings;trigger.model.load(\"DurationLoop\", 10, 0.01);trigger.model.initiate();", - "description": "Reset the instrument.\n--- --Set the instrument to measure current.\n--- --Load the duration loop trigger model to take measurements for 10 s with a 10\u00a0ms delay before each measurement.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "digio.writeport()", - "webhelpfile": "30981.htm", - "signature": "digio.writeport(data)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function writes to all digital I/O lines.", - "details": "This function writes to the digital I/O port by setting the binary state of each digital line from an integer equivalent value.The binary representation of the value indicates the output pattern to be written to the I/O port. For example, a value of 63 has a binary equivalent of 111111 (all lines are set high); a data value of 42 has a binary equivalent of 101010 (lines 2, 4, and 6 are set high, and the other three lines are set low).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.You can also enter the data parameter as a binary value.", - "param_info": [ - { - "name": "data", - "description": "The value to write to the port (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "digio.writeport(data)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.writeport(63);", - "description": "Sets digital I/O lines 1 through 6 high (binary 111111).\n" - }, - { - "example": "digio.writeport(0b111111);", - "description": "Sets digital I/O lines 1 through 6 high (digital\u00a063).\n" - } - ], - "related_commands": [ - "digio.readport()", - "Outputting a bit pattern" - ] - }, - { - "name": "digio.line[N].state", - "webhelpfile": "30982.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This function sets a digital I/O line high or low when the line is set for digital control and returns the state on the digital I/O lines.", - "details": "When a reset occurs, the digital line state can be read as high because the digital line is reset to a digital input. A digital input floats high if nothing is connected to the digital line.This returns the integer equivalent values of the binary states on all six digital I/O lines.Set the state to digio.STATE_LOW to clear the bit; set the state to digio.STATE_HIGH to set the bit.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "state", - "description": "Set the line low", - "enum": "digio.STATE_LOW nil|digio.STATE_HIGH nil", - "type": "digiolinestatestate", - "range": "" - } - ], - "usage": [ - "digio.line[N].state = state", - "state = digio.line[N].state" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_DIGITAL_OUT;digio.line[1].state = digio.STATE_HIGH;", - "description": "Sets line 1 (bit B1) of the digital I/O port high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.readport()", - "digio.writeport()", - "trigger.digin[N].edge" - ] - }, - { - "name": "trigger.timer[N].reset()", - "webhelpfile": "31076.htm", - "signature": "trigger.timer[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets trigger timer settings to their default values.", - "details": "The trigger.timer[N].reset() function resets the following attributes to their default values:It also clears trigger.timer[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "trigger.timer[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].reset();", - "description": "Resets the attributes associated with timer 1 to their default values.\n" - } - ], - "related_commands": [ - "trigger.timer[N].count", - "trigger.timer[N].delay", - "trigger.timer[N].delaylist", - "trigger.timer[N].enable", - "trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.generate", - "trigger.timer[N].start.overrun", - "trigger.timer[N].start.seconds", - "trigger.timer[N].start.stimulus" - ] - }, - { - "name": " trigger.BLOCK_WAIT", - "webhelpfile": "31093.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that waits for an event before allowing the trigger model to continue.", - "details": "The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger block allows trigger execution to continue (see Details)", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "(see Details)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITclear", - "range": "" - }, - { - "name": "logic", - "description": "If each event must occur before the trigger model continues", - "enum": "trigger.WAIT_AND nil|trigger.WAIT_OR nil", - "type": "triggermodelsetblocktriggerBLOCK_WAITlogic", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event, event)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_WAIT, event, clear, logic, event)" - ], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);", - "description": "Set trigger model block 9 to wait for a user to press the TRIGGER key on the front panel before continuing.\n" - } - ], - "related_commands": [ - "Wait block" - ] - }, - { - "name": " trigger.BLOCK_MEASURE_DIGITIZE", - "webhelpfile": "31094.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger block that makes or digitizes a measurement.", - "details": "When you set the count to auto, the trigger model uses the count value that is active for the selected function instead of a specific value. You can use this with configuration lists to change the count value each time a measure/digitize block is encountered.Firmware versions of the DMM7510 before version 1.7.0 had a separate measure and digitize block. If you have code that is using that block, it works in this version of the DMM7510 firmware.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the buffer, which must be an existing buffer; if no buffer is defined, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "count", - "description": "The number of measure or digitize readings to make before moving to the next block in the trigger model; set to", - "enum": "trigger.COUNT_INFINITE nil|trigger.COUNT_STOP nil|trigger.COUNT_AUTO nil", - "type": "triggermodelsetblocktriggerBLOCK_MEASURE_DIGITIZEcount", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName, count)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_MEASURE_DIGITIZE, bufferName)" - ], - "examples": [ - { - "example": "reset();dmm.measure.func = dmm.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set the function to measure DC voltage.\n--- --Set block 1 to clear defbuffer1.\n--- --Set block 2 to set a delay of 0.\n--- --Set block 3 to make measurements infinitely.\n--- --Set block 4 to wait until the front-panel TRIGGER key is pressed.\n--- --Set block 5 to stop making measurements.\n--- --Set block 6 to send a notification.\n--- --Start the trigger model.\n--- --You must press the front-panel TRIGGER key to stop measurements.\n--- --Output the number of readings.\n" - }, - { - "example": "reset();dmm.measure.configlist.create(\"countactive\");dmm.measure.count = 2;dmm.measure.configlist.store(\"countactive\") -- index1;dmm.measure.count = 10;dmm.measure.configlist.store(\"countactive\") -- index2;dmm.measure.count = 3;dmm.measure.configlist.store(\"countactive\") -- index3;\u00a0;trigger.model.setblock(1, trigger.BLOCK_CONFIG_NEXT, \"countactive\");trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_AUTO);trigger.model.setblock(3, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 3, 1);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset the instrument.\n--- --Set up a configuration list named countactive.\n--- --Set the measure count to 2 (replace dmm.measure.count with dmm.digitize.count if using a digitize function.)\n--- --Store the count in index 1.\n--- --Set the measure count to 10.\n--- --Store the count in index 2.\n--- --Set the measure count to 3.\n--- --Store the count in index 3.\n--- --Set up trigger model block 1 to call the next index from the countactive configuration list.\n--- --Set block 2 to measure or digitize and store the readings in defbuffer1, using the most recent count value.\n--- --Set block 3 to add a delay of 1\u00a0s.\n--- --Set block 4 to iterate through the trigger model 3 times, returning to block 1.\n--- --Start the trigger model.\n--- --Output the number of readings. There should be 15 readings.\n" - } - ], - "related_commands": [ - "buffer.make()", - "Measure/Digitize block" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_RECALL", - "webhelpfile": "31096.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the system settings that are stored in a configuration list.", - "details": "When the trigger model reaches a configuration recall block, the settings in the specified configuration list are recalled.You can restore a specific set of configuration settings in the configuration list by defining the index.The configuration list must be defined before you can use this block. If the configuration list changes, verify that the trigger model count is still accurate.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the configuration list to recall", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "index", - "description": "The index in the configuration list to recall; default is 1", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList, index)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_RECALL, configurationList)" - ], - "examples": [ - { - "example": "trigger.model.setblock(3, trigger.BLOCK_CONFIG_RECALL, \"measTrigList\", 5);", - "description": "Configure trigger block 3 to load index 5 from the configuration list named measTrigList.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_NEXT", - "webhelpfile": "31097.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function recalls the settings at the next index of a configuration list.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the configuration list to recall", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_NEXT, configurationList)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_CONFIG_NEXT, \"measTrigList\");", - "description": "Configure trigger block 5 to load the next index in the configuration list named measTrigList.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_CONFIG_PREV", - "webhelpfile": "31098.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that recalls the settings stored at the previous index in a configuration list.", - "details": "The Config List Prev block defines a trigger model block that recalls the settings stored at the previous index in a configuration list.The configuration list previous index trigger block type recalls the previous index in a configuration list. It configures the settings of the instrument based on the settings at that index. The trigger model executes the settings at that index before the next block is executed.The first time the trigger model encounters this block, the last index in the configuration list is recalled. Each subsequent time trigger model execution reaches a configuration list previous block for this configuration list, it goes backward one index. When the first index in the list is reached, it goes to the last index in the configuration list.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "configurationList", - "description": "A string that defines the configuration list to recall", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_CONFIG_PREV, configurationList)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(8, trigger.BLOCK_CONFIG_PREV, \"measTrigList\");", - "description": "Configure trigger block 8 to load the previous index in the configuration list named measTrigList.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_DELAY_DYNAMIC", - "webhelpfile": "31101.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a user delay to the execution of the trigger model.", - "details": "Each measure function can have up to five unique user delay times (M1 to M5). Digitize user delays are handled as measure user delays, so you can have a total of five measure and digitize user delays. The delay time is set by the user-delay command, which is only available over a remote interface. Though the trigger model can be used with any function, the user delay is set per function. Make sure you are setting the delay for the function you intend to use with the trigger model. The measure user-delay settings are used with measure functions; the digitize user-delay functions are used with digitize functions.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "n", - "description": "The number of the user delay, 1 to 5, set by dmm.measure.userdelay[N] or dmm.digitize.userdelay[N]", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_Mn)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");dmm.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay 1 for measurements to 5 s.\n--- --Set trigger block 1 to a dynamic delay that calls user delay 1.\n--- --Set trigger block 2 to make or digitize a measurement.\n--- --Set trigger block 3 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "dmm.digitize.userdelay[N]", - "dmm.measure.userdelay[N]" - ] - }, - { - "name": " trigger.BLOCK_DIGITAL_IO", - "webhelpfile": "31102.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that sets the lines on the digital I/O port high or low.", - "details": "The bit mask defines the bits in the pattern that are driven high or low. A binary 1 in the bit mask indicates that the corresponding I/O line should be driven according to the bit pattern. To drive all lines, specify all ones (63, 0x3F, 0b111111) or omit this parameter. If the bit for a line in the bit pattern is set to 1, the line is driven high. If the bit is set to 0 in the bit pattern, the line is driven low.For this block to work as expected, make sure you configure the trigger type and line state of the digital line for use with the trigger model (use the digital line mode command).", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bitPattern", - "description": "Sets the value that specifies the output line bit pattern (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - }, - { - "name": "bitMask", - "description": "Specifies the bit mask; if omitted, all lines are driven (0 to 63)", - "enum": "", - "type": "number", - "range": "(0 to 63)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DIGITAL_IO, bitPattern, bitMask)" - ], - "overloads": [], - "examples": [ - { - "example": "for x = 3, 6 do digio.line[x].mode = digio.MODE_DIGITAL_OUT end;trigger.model.setblock(4, trigger.BLOCK_DIGITAL_IO, 20, 60);", - "description": "The for loop configures digital I./O lines 3 through 6 as digital outputs. Trigger block 4 is then configured with a bit pattern of 20 (digital I/O lines 3 and 5 high). The optional bit mask is specified as 60 (lines 3 through 6), so both lines 3 and 5 are driven high.\n" - } - ], - "related_commands": [ - "digio.line[N].mode" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_COUNTER", - "webhelpfile": "31103.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that branches to a specified block a specified number of times.", - "details": "This command defines a trigger model building block that branches to another block using a counter to iterate a specified number of times.Counters increment every time the trigger model reaches them until they are more than or equal to the count value. At that point, the trigger model continues to the next building block in the sequence.The counter is reset to 0 when the trigger model starts. It is incremented each time trigger model execution reaches the counter block.If you are using remote commands, you can query the counter. The counter is incremented immediately before the branch compares the actual counter value to the set counter value. Therefore, the counter is at 0 until the first comparison. When the trigger model reaches the set counter value, branching stops and the counter value is one greater than the setting. Use trigger.model.getbranchcount() to query the counter.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetCount", - "description": "The number of times to repeat", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the counter is less than the targetCount value", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_COUNTER, targetCount, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_BRANCH_COUNTER, 10, 2);print(trigger.model.getbranchcount(4));", - "description": "When the trigger model reaches this block, the trigger model returns to block 2. This repeats 10 times.\n--- --An example of the return if the trigger model has reached this block 5 times is:\n--- --5\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_RESET_BRANCH_COUNT" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ON_EVENT", - "webhelpfile": "31104.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) ", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function branches to a specified block when a specified trigger event occurs.", - "details": "If you are using a timer, it must be started before it can expire. One method to start the timer in the trigger model is to include a Notify block before the On Event block. Set the Notify block to use the same timer as the On Event block.The following table shows the constants for the events.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "event", - "description": "The event that must occur before the trigger model branches the specified block", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the specified event occurs", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ON_EVENT, event, branchToBlock) " - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ON_EVENT, trigger.EVENT_DISPLAY, 2);", - "description": "When the trigger model reaches this block, if the front-panel TRIGGER key has been pressed, the trigger model returns to block 2. If the TRIGGER key has not been pressed, the trigger model continues to block 7 (the next block in the trigger model).\n" - } - ], - "related_commands": [ - "On event block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_CONSTANT", - "webhelpfile": "31105.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if a measurement meets preset criteria.", - "details": "The type of limit can be:The measurement block must be a measure/digitize block that occurs in the trigger model before the branch-on-constant-limits block. The last measurement from a measure/digitize block is used.If the limit A is more than the limit B, the values are automatically swapped so that the lesser value is used as the lower limit.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitType", - "range": "" - }, - { - "name": "limitA", - "description": "The lower limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitA", - "range": "" - }, - { - "name": "limitB", - "description": "The upper limit that the measurement is tested against; if limitType is set to", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_CONSTANTlimitB", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the defined criteria", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, limitType, limitA, limitB, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_LIMIT_CONSTANT, trigger.LIMIT_ABOVE, 0.1, 1, 2);", - "description": "Sets trigger block 5 to be a constant limit that branches to block 2 when the measurement is above the value set for limit B (which is set to 1). Note that limit A must be set but is ignored. \n" - } - ], - "related_commands": [ - "Constant Limit block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_DELTA", - "webhelpfile": "31107.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.", - "details": "This block calculates the difference between the last two measurements from a measure/digitize block. It subtracts the most recent measurement from the previous measurement.The difference between the measurements is compared to the target difference. If the difference is less than the target difference, the trigger model goes to the specified branching block. If the difference is more than the target difference, the trigger model proceeds to the next block in the trigger block sequence.If you do not define the measure/digitize block, it will compare measurements of a measure/digitize block that precedes the branch delta block. For example, if you have a measure/digitize block, a wait block, another measure/digitize block, another wait block, and then the branch delta block, the delta block compares the measurements from the second measure/digitize block. If a preceding measure/digitize block does not exist, an error occurs.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "targetDifference", - "description": "The value against which the block compares the difference between the measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the difference between the measurements is less than or equal to the targetDifference", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_DELTA, targetDifference, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(5, trigger.BLOCK_BRANCH_DELTA, 0.35, 8, 3);", - "description": "Configure trigger block 5 to branch to block 8 when the measurement difference from block 3 is less than 0.35.\n" - } - ], - "related_commands": [ - "Delta block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE", - "webhelpfile": "31108.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.", - "details": "The branch-once building block branches to a specified block the first time trigger model execution encounters the branch-once block. If it is encountered again, the trigger model ignores the block and continues in the normal sequence.The once block is reset when trigger model execution reaches the idle state. Therefore, the branch-once block always executes the first time the trigger model execution encounters this block.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model first encounters this block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE, 4);", - "description": "When the trigger model reaches block 2, the trigger model goes to block 4 instead of going in the default sequence of block 3.\n" - } - ], - "related_commands": [ - "Once block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ONCE_EXCLUDED", - "webhelpfile": "31109.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.", - "details": "The branch-once-excluded block is ignored the first time the trigger model encounters it. After the first encounter, the trigger model goes to the specified branching block.The branch-once-excluded block is reset when the trigger model starts or is placed in idle.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the trigger model encounters this block after the first encounter", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(2, trigger.BLOCK_BRANCH_ONCE_EXCLUDED, 4);", - "description": "When the trigger model reaches block 2 the first time, the trigger model goes to block 3. If the trigger model reaches this block again, the trigger model goes to block 4.\n" - } - ], - "related_commands": [ - "Once excluded block" - ] - }, - { - "name": " trigger.BLOCK_NOTIFY", - "webhelpfile": "31110.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that generates a trigger event and immediately continues to the next block.", - "details": "", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "The identification number of the notification; 1 to 8", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFYN)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.model.setblock(5, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY2);trigger.digout[3].stimulus = trigger.EVENT_NOTIFY2;", - "description": "Define trigger model block 5 to be the notify 2 event. Assign the notify 2 event to be the stimulus for digital output line 3.\n" - } - ], - "related_commands": [ - "Notify block" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_ALWAYS", - "webhelpfile": "31112.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that always goes to a specific block.", - "details": "When the trigger model reaches a branch-always building block, it goes to the building block set by branchToBlock.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "branchToBlock", - "description": "The block number to execute when the trigger model reaches the Branch Always block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_ALWAYS, branchToBlock)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(6, trigger.BLOCK_BRANCH_ALWAYS, 20);", - "description": "When the trigger model reaches block 6, always branch to block 20.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_BRANCH_LIMIT_DYNAMIC", - "webhelpfile": "31114.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.", - "details": "The measure/digitize block must occur in the trigger model before the branch-on-dynamic-limits block. If no block is defined, the measurement from the previous measure/digitize block is used. If no previous measure/digitize block exists, an error is reported.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitType", - "description": "The type of limit, which can be one of the following types", - "enum": "trigger.LIMIT_ABOVE nil|trigger.LIMIT_BELOW nil|trigger.LIMIT_INSIDE nil|trigger.LIMIT_OUTSIDE nil", - "type": "triggermodelsetblocktriggerBLOCK_BRANCH_LIMIT_DYNAMIClimitType", - "range": "" - }, - { - "name": "limitNumber", - "description": "The limit number (1 or 2)", - "enum": "", - "type": "1|2", - "range": "(1 or 2)" - }, - { - "name": "branchToBlock", - "description": "The block number of the trigger model block to execute when the measurement meets the criteria set in the configuration list", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "measureBlock", - "description": "The block number of the measure/digitize block that makes the measurements to be compared; if this is 0 or undefined, the trigger model uses the previous measure/digitize block", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)", - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock, measureBlock)" - ], - "overloads": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, limitType, limitNumber, branchToBlock)" - ], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_BRANCH_LIMIT_DYNAMIC, trigger.LIMIT_OUTSIDE, 2, 10, 5);", - "description": "Configure block 7 to check if limit 2 is outside its limit values, based on the measurements made in block 5. If values are outside the measurements, branch to block 10. If the values are not outside the measurements, trigger model execution continues to block 8.\n" - } - ], - "related_commands": [ - "Dynamic Limit block", - "dmm.measure.limit[Y].low.value", - "dmm.measure.limit[Y].high.value" - ] - }, - { - "name": " trigger.BLOCK_DELAY_CONSTANT", - "webhelpfile": "31347.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function adds a constant delay to the execution of a trigger model.", - "details": "When trigger model execution reaches a delay block, it stops normal measurement and trigger model operation for the time set by the delay. Background measurements continue to be made, and if any previously executed block started infinite measurements, they also continue to be made.If other delays have been set, this delay is in addition to the other delays.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "time", - "description": "The amount of time to delay in seconds (167 ns to 10 ks, or 0 for no delay)", - "enum": "", - "type": "number", - "range": "(167 ns to 10 ks, or 0 for no delay)" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_DELAY_CONSTANT, time)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(7, trigger.BLOCK_DELAY_CONSTANT, 30e-3);", - "description": "Configure trigger block 7 to delay the trigger model before the next block until a delay of 30 ms elapses.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digin[N].edge", - "webhelpfile": "31360.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the edge used by the trigger event detector on the given trigger line.", - "details": "This command sets the logic on which the trigger event detector and the output trigger generator operate on the specified trigger line.To directly control the line state, set the mode of the line to digital and use the write command. When the digital line mode is set for open drain, the edge settings assert a TTL low-pulse.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger logic value", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggerdiginedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "detectedEdge = trigger.digin[N].edge", - "trigger.digin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;trigger.digin[4].edge = trigger.EDGE_RISING;", - "description": "Sets the trigger mode for digital I/O line\u00a04 to detect a rising-edge trigger as an input.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "digio.writeport()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "digio.line[N].mode", - "webhelpfile": "31363.htm", - "signature": "", - "command_return": "lineMode", - "type": "Attribute (RW)", - "default_value": "digio.MODE_DIGITAL_IN\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the mode of the digital I/O line to be a digital line, trigger line, or synchronous line and sets the line to be input, output, or open-drain.", - "details": "", - "param_info": [ - { - "name": "lineMode", - "description": "The digital line control type and line mode", - "enum": "digio.MODE_DIGITAL_IN nil|digio.MODE_DIGITAL_OUT nil|digio.MODE_DIGITAL_OPEN_DRAIN nil|digio.MODE_TRIGGER_IN nil|digio.MODE_TRIGGER_OUT nil|digio.MODE_TRIGGER_OPEN_DRAIN nil|digio.MODE_SYNCHRONOUS_MASTER nil|digio.MODE_SYNCHRONOUS_ACCEPTOR nil", - "type": "digiolinemodelineMode", - "range": "" - }, - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "lineMode = digio.line[N].mode", - "digio.line[N].mode = lineMode" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[1].mode = digio.MODE_TRIGGER_OUT;", - "description": "Set digital I/O line 1 to be an output trigger line.\n" - } - ], - "related_commands": [ - "trigger.digin[N].edge" - ] - }, - { - "name": "digio.readport()", - "webhelpfile": "31368.htm", - "signature": "digio.readport()", - "command_return": "data", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function reads the digital I/O port.", - "details": "The binary equivalent of the returned value indicates the value of the input lines on the digital I/O port. The least significant bit (bit B1) of the binary number corresponds to digital I/O line 1; bit B6 corresponds to digital I/O line 6.For example, a returned value of 42 has a binary equivalent of 101010, which indicates that lines 2, 4, 6 are high (1), and the other lines are low (0).An instrument reset does not affect the present states of the digital I/O lines.All six lines must be configured as digital control lines. If not, this command generates an error.", - "param_info": [ - { - "name": "data", - "description": "The present value of the input lines on the digital I/O port", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "data = digio.readport()" - ], - "overloads": [], - "examples": [ - { - "example": "data = digio.readport();print(data);", - "description": "Assume lines 2, 4, and 6 are set high when the I/O port is read.\n--- --Output:\n--- --42\n--- --This is binary 101010\n" - } - ], - "related_commands": [ - "digio.writeport()" - ] - }, - { - "name": "trigger.digin[N].clear()", - "webhelpfile": "31373.htm", - "signature": "trigger.digin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on a digital input line.", - "details": "The event detector of a trigger enters the detected state when an event is detected. For the specified trigger line, this command clears the event detector, discards the history, and clears the overrun status(sets the overrun status to false).", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.digin[2].clear();", - "description": "Clears the trigger event detector on I/O line\u00a02.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digin[N].wait()" - ] - }, - { - "name": "trigger.digin[N].overrun", - "webhelpfile": "31378.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "overrun = trigger.digin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.digin[1].overrun;print(overrun);", - "description": "If there is no trigger overrun on digital input\u00a01, the output is:\n--- --false\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].pulsewidth", - "webhelpfile": "31385.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10\u00a0us)\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use trigger.digout[N].release().", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0 to 100 ks)" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "width = trigger.digout[N].pulsewidth", - "trigger.digout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].pulsewidth = 20e-6;", - "description": "Sets the pulse width for trigger line 4 to 20\u00a0\u00b5s.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()", - "trigger.digout[N].assert()", - "trigger.digout[N].release()" - ] - }, - { - "name": "trigger.digout[N].assert()", - "webhelpfile": "31392.htm", - "signature": "trigger.digout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger pulse on one of the digital I/O lines.", - "details": "Initiates a trigger event and does not wait for completion. The pulse width that is set determines how long the instrument asserts the trigger.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[2].mode = digio.MODE_TRIGGER_OUT;trigger.digout[2].pulsewidth = 20e-6;trigger.digout[2].assert();", - "description": "Asserts a trigger on digital I/O line 2 with a pulse width of 20\u00a0us.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "digio.line[N].reset()", - "webhelpfile": "31393.htm", - "signature": "digio.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets digital I/O line values to their factory defaults.", - "details": "This function resets the following attributes to their default values:It also clears trigger.digin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The digital I/O line", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "digio.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "-- Set the digital I/O trigger line 3 for a falling edge;digio.line[3].mode = digio.MODE_TRIGGER_OUT;trigger.digout[3].logic = trigger.LOGIC_NEGATIVE;-- Set the digital I/O trigger line 3 to have a pulsewidth of 50 microseconds.;trigger.digout[3].pulsewidth = 50e-6;-- Use digital I/O line 5 to trigger the event on line 3.;trigger.digout[3].stimulus = trigger.EVENT_DIGIO5;-- Print configuration (before reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);-- Reset the line back to factory default values.;digio.line[3].reset();-- Print configuration (after reset).;print(digio.line[3].mode, trigger.digout[3].pulsewidth, trigger.digout[3].stimulus);", - "description": "Output before reset:\n--- --digio.MODE_TRIGGER_OUT 5e-05 trigger.EVENT_DIGIO5\n--- --\u00a0\n--- --Output after reset:\n--- --digio.MODE_TRIGGER_IN 1e-05 trigger.EVENT_NONE\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].overrun", - "trigger.digout[N].pulsewidth", - "trigger.digout[N].stimulus" - ] - }, - { - "name": "trigger.digin[N].wait()", - "webhelpfile": "31394.htm", - "signature": "trigger.digin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time trigger.digin[N].wait() or trigger.digin[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and is ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detected", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.digin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_IN;triggered = trigger.digin[4].wait(3);print(triggered);", - "description": "Waits up to 3 s for a trigger to be detected on trigger line 4, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digin[N].clear()" - ] - }, - { - "name": "trigger.digout[N].release()", - "webhelpfile": "31395.htm", - "signature": "trigger.digout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger.", - "details": "Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "trigger.digout[N].assert()", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "trigger.lanout[N].assert()", - "webhelpfile": "31396.htm", - "signature": "trigger.lanout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding event.", - "details": "Generates and sends a LAN trigger packet for the LAN event number specified.Sets the pseudo line state to the appropriate state.The following indexes provide the listed LXI events:", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].assert();", - "description": "Creates a trigger with LAN trigger 5.\n" - } - ], - "related_commands": [ - "lan.lxidomain", - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].wait()", - "webhelpfile": "31397.htm", - "signature": "trigger.lanin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for an input trigger.", - "details": "If one or more trigger events have been detected since the last time trigger.lanin[N].wait() or trigger.lanin[N].clear() was called, this function returns immediately.After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The trigger packet over LAN to wait for (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.lanin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.lanin[5].wait(3);", - "description": "Wait for a trigger event with LAN trigger 5 with a timeout of 3\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].overrun", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanin[N].clear()", - "webhelpfile": "31398.htm", - "signature": "trigger.lanin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. This function clears a trigger event detector and discards the history of the trigger packet.This function clears all overruns associated with this LAN trigger.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8) to clear", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanin[5].clear();", - "description": "Clears the event detector with LAN event trigger 5.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun" - ] - }, - { - "name": "trigger.lanout[N].connect()", - "webhelpfile": "31401.htm", - "signature": "trigger.lanout[N].connect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function prepares the event generator for outgoing trigger events.", - "details": "This command prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.The event generator automatically disconnects when either the protocol or IP address for this event is changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].connect()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;trigger.lanout[1].connect();trigger.lanout[1].assert();", - "description": "Set the protocol for LAN trigger\u00a01 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger\u00a01 by asserting it.\n" - } - ], - "related_commands": [ - "trigger.lanin[N].overrun", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].disconnect()", - "webhelpfile": "31404.htm", - "signature": "trigger.lanout[N].disconnect()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function disconnects the LAN trigger event generator.", - "details": "When this command is set for TCP connections, this closes the TCP connection.The LAN trigger automatically disconnects when either the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attributes for this event are changed.", - "param_info": [ - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "trigger.lanout[N].disconnect()" - ], - "overloads": [], - "examples": [], - "related_commands": [ - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].connected", - "webhelpfile": "31406.htm", - "signature": "", - "command_return": "connected", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the LAN event connection state.", - "details": "This is set to true when the LAN trigger is connected and ready to send trigger events after a successful trigger.lanout[N].connect() command. If the LAN trigger is not ready to send trigger events, this value is false.This attribute is also false when the trigger.lanout[N].protocol or trigger.lanout[N].ipaddress attribute is changed or when the remote connection closes the connection.", - "param_info": [ - { - "name": "connected", - "description": "The LAN event connection state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "connected = trigger.lanout[N].connected" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[1].protocol = lan.PROTOCOL_MULTICAST;print(trigger.lanout[1].connected);", - "description": "Outputs true if connected, or false if not connected.\n--- --Example output:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress", - "trigger.lanout[N].protocol" - ] - }, - { - "name": "trigger.lanout[N].ipaddress", - "webhelpfile": "31409.htm", - "signature": "", - "command_return": "ipAddress", - "type": "Attribute (RW)", - "default_value": "\"0.0.0.0\"\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the address (in dotted-decimal format) of UDP or TCP listeners.", - "details": "Sets the IP address for outgoing trigger events.After you change this setting, you must send the connect command before outgoing messages can be sent.", - "param_info": [ - { - "name": "ipAddress", - "description": "The LAN address for this attribute as a string in dotted decimal notation", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "ipAddress = trigger.lanout[N].ipaddress", - "trigger.lanout[N].ipaddress = ipAddress" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[3].protocol = lan.PROTOCOL_TCP;trigger.lanout[3].ipaddress = \"192.0.32.10\";trigger.lanout[3].connect();", - "description": "Set the protocol for LAN trigger\u00a03 to be TCP when sending LAN triggers.\n--- --Use IP address \"192.0.32.10\" to connect the LAN trigger.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()" - ] - }, - { - "name": "trigger.lanin[N].overrun", - "webhelpfile": "31413.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the overrun status of the LAN event detector.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "The trigger overrun state for the specified LAN packet (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "overrun = trigger.lanin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.lanin[5].overrun;print(overrun);", - "description": "Checks the overrun status of a trigger on LAN5 and outputs the value, such as:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.lanin[N].clear()", - "trigger.lanin[N].wait()", - "trigger.lanout[N].assert()", - "trigger.lanout[N].stimulus" - ] - }, - { - "name": "trigger.lanout[N].protocol", - "webhelpfile": "31416.htm", - "signature": "", - "command_return": "protocol", - "type": "Attribute (RW)", - "default_value": "lan.PROTOCOL_TCP\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the LAN protocol to use for sending trigger messages.", - "details": "The LAN trigger listens for trigger messages on all the supported protocols. However, it uses the designated protocol for sending outgoing messages.After you change this setting, you must re-connect the LAN trigger event generator before you can send outgoing event messages.When multicast is selected, the trigger IP address is ignored, and event messages are sent to the multicast address 224.0.23.159.", - "param_info": [ - { - "name": "protocol", - "description": "The protocol to use for messages from the trigger", - "enum": "lan.PROTOCOL_TCP nil|lan.PROTOCOL_UDP nil|lan.PROTOCOL_MULTICAST nil", - "type": "triggerlanoutprotocolprotocol", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "protocol = trigger.lanout[N].protocol", - "trigger.lanout[N].protocol = protocol" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.lanout[1].protocol);", - "description": "Get LAN protocol that is being used for sending trigger messages for LAN event 1.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "trigger.lanout[N].stimulus", - "webhelpfile": "31419.htm", - "signature": "", - "command_return": "LANevent", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies events that cause this trigger to assert.", - "details": "This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set the event to one of the existing trigger events, which are shown in the following table.Setting this attribute to none disables automatic trigger generation.If any events are detected before the trigger LAN connection is sent, the event is ignored, and the action overrun is set.", - "param_info": [ - { - "name": "LANevent", - "description": "The LAN event that causes this trigger to assert; see Details for values", - "enum": "", - "type": "triggerEvents", - "range": "" - }, - { - "name": "N", - "description": "A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "LANevent = trigger.lanout[N].stimulus", - "trigger.lanout[N].stimulus = LANevent" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[5].stimulus = trigger.EVENT_TIMER1;", - "description": "Use the timer 1 trigger event as the source for LAN trigger 5 stimulus.\n" - } - ], - "related_commands": [ - "trigger.lanout[N].connect()", - "trigger.lanout[N].ipaddress" - ] - }, - { - "name": "dmm.measure.userdelay[N]", - "webhelpfile": "31441.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay (0 for no delay, or 167\u00a0ns to 10 ks)", - "enum": "", - "type": "number", - "range": "(0 for no delay, or 167\u00a0ns to 10 ks)" - }, - { - "name": "N", - "description": "The user delay to which this time applies (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The measurement function; see Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "delayTime = dmm.measure.userdelay[N]", - "dmm.measure.userdelay[N] = delayTime", - "delayTime = dmm.measure.getattribute(function, ATTR_MEAS_USER_DELAY_N)", - "dmm.measure.setattribute(function, ATTR_MEAS_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");dmm.measure.userdelay[1] = 5;trigger.model.setblock(1, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M1);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 10, 1);trigger.model.initiate();", - "description": "Set user delay 1 for measurements to 5 s.\n--- --Set trigger block 1 to a dynamic delay that calls user delay 1.\n--- --Set trigger block 2 to make or digitize a measurement.\n--- --Set trigger block 3 to branch to block 1 ten times.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "dmm.digitize.userdelay[N]", - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "dmm.measure.readwithtime()", - "webhelpfile": "31457.htm", - "signature": "dmm.measure.readwithtime()", - "command_return": "reading, seconds, fractional", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates measurements and returns the last actual measurement and time information in UTC format without using the trigger model.", - "details": "This command initiates measurements using the present function setting, stores the readings in a reading buffer, and returns the last reading.The dmm.measure.count attribute determines how many measurements are performed.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "seconds", - "description": "Seconds in UTC format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractional", - "description": "Fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading, seconds, fractional = dmm.measure.readwithtime()", - "dmm.measure.readwithtime(bufferName)" - ], - "overloads": [ - "dmm.measure.readwithtime(bufferName)" - ], - "examples": [ - { - "example": "print(dmm.measure.readwithtime(defbuffer1));", - "description": "Print the last measurement and time information from defbuffer1 in UTC format, which will look similar to:\n--- ---1.405293589829e-11 1400904629 0.1950935\n" - } - ], - "related_commands": [ - "dmm.digitize.readwithtime()", - "dmm.measure.count", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "status.questionable.setmap()", - "webhelpfile": "31612.htm", - "signature": "status.questionable.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function maps events to bits in the questionable event registers.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.questionable.setmap(bitNumber, setEvent)", - "status.questionable.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.questionable.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.questionable.setmap(0, 4917, 4918);", - "description": "When event 4917 (a default buffer is 0% filled) occurs, bit 0 is set in the condition register and the event register of the Questionable Event Register. When event 4918 (a default buffer is 100% filled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "status.questionable.getmap()" - ] - }, - { - "name": "status.questionable.getmap()", - "webhelpfile": "31613.htm", - "signature": "status.questionable.getmap(bitNumber)", - "command_return": "setEvent, clearEvent", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function requests the mapped set event and mapped clear event status for a bit in the Questionable Event Registers.", - "details": "When you query the mapping for a specific bit, the instrument returns the events that were mapped to set and clear that bit. Zero (0) indicates that the bits have not been set.", - "param_info": [ - { - "name": "setEvent", - "description": "The event mapped to set this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The event mapped to clear this bit; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bitNumber", - "description": "The bit number to check (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - } - ], - "usage": [ - "setEvent, clearEvent = status.questionable.getmap(bitNumber)" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.getmap(9));", - "description": "Returns the events that were mapped to set and clear bit 9.\n" - } - ], - "related_commands": [ - "Questionable Event Register", - "status.questionable.setmap()" - ] - }, - { - "name": "status.questionable.condition", - "webhelpfile": "31614.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Questionable Condition Register of the status model.", - "details": "This command reads the contents of the Questionable Condition Register, which is one of the Questionable Event Registers.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.questionable.condition);", - "description": "Reads the Questionable Condition Register.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.questionable.enable", - "webhelpfile": "31615.htm", - "signature": "", - "command_return": "questionableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the questionable event enable register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Questionable Event Register.When one of these bits is set, when the corresponding bit in the Questionable Event Register or Questionable Condition Register is set, the MSB and QSM bits in the Status Byte Register are set.", - "param_info": [ - { - "name": "questionableRegister", - "description": "The value of the register (0 to 65535)", - "enum": "", - "type": "number", - "range": "(0 to 65535)" - } - ], - "usage": [ - "questionableRegister = status.questionable.enable", - "status.questionable.enable = questionableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "status.questionable.enable = 17;print(status.questionable.enable);", - "description": "Set bits 0 and 4 of the Questionable Event Enable Register.\n--- --Returns 17, which indicates the register was set correctly.\n" - } - ], - "related_commands": [ - "Questionable Event Register" - ] - }, - { - "name": "status.condition", - "webhelpfile": "31635.htm", - "signature": "", - "command_return": "statusByte", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the status byte condition register.", - "details": "You can use this command to read the status byte, which is returned as a numeric value. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence. The returned value can indicate that one or more status events occurred. If more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).The meanings of the individual bits of this register are shown in the following table.", - "param_info": [ - { - "name": "statusByte", - "description": "The status byte", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "statusByte = status.condition" - ], - "overloads": [], - "examples": [ - { - "example": "statusByte = status.condition;print(statusByte);", - "description": "Returns statusByte.\n--- --Example output:\n--- --1.29000e+02\n--- --Converting this output (129) to its binary equivalent yields 1000 0001 \n--- --Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.operation.enable", - "webhelpfile": "31637.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute sets or reads the contents of the Operation Event Enable Register of the status model.", - "details": "This command sets or reads the contents of the Enable register of the Operation Event Register.When one of these bits is set, when the corresponding bit in the Operation Event Register or Operation Condition Register is set, the OSB bit in the Status Byte Register is set.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.enable", - "status.operation.enable = operationRegister" - ], - "overloads": [], - "examples": [ - { - "example": "-- decimal 20480 = binary 0101 0000 0000 0000;operationRegister = 20480;status.operation.enable = operationRegister;", - "description": "Sets the 12 and 14 bits of the operation status enable register using a decimal value.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.event", - "webhelpfile": "31638.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This attribute reads the operation event register of the status model.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "operationRegister = status.operation.event" - ], - "overloads": [], - "examples": [ - { - "example": "status.request_enable = status.OSB ;status.operation.setmap(0, 4918, 4917);status.operation.enable = 1;defbuffer1.clear();defbuffer1.fillmode = buffer.FILL_ONCE;defbuffer1.capacity = 10;dmm.measure.count = 10;dmm.measure.read();print(status.operation.event);", - "description": "Set bits in the Status Request Enable Register to record an enabled event in the Operation Status Register.\n--- --Map event number 4918 (a default buffer is full) to set bit 0 in the Operation Event Register and event number 4917 (a default buffer is empty) to clear bit 0.\n--- --Clear defbuffer1.\n--- --Set defbuffer1 to fill once.\n--- --Resizes defbuffer1 to 10 readings. \n--- --Sets the measure count to 10 readings and makes a measurement. \n--- --Reads the operation event register.\n--- --Output:\n--- --1\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.condition", - "webhelpfile": "31639.htm", - "signature": "", - "command_return": "operationRegister", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the Operation Event Register of the status model.", - "details": "This command reads the contents of the Operation Condition Register, which is one of the Operation Event Registers.For detail on interpreting the value of a register, see Understanding bit settings.", - "param_info": [ - { - "name": "operationRegister", - "description": "The status of the operation status register; a zero (0) indicates no bits set; other values indicate various bit settings", - "enum": "", - "type": "number", - "range": "(0)" - } - ], - "usage": [ - "operationRegister = status.operation.condition" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.operation.condition);", - "description": "Returns the contents of the register.\n" - } - ], - "related_commands": [ - "Operation Event Register" - ] - }, - { - "name": "status.operation.setmap()", - "webhelpfile": "31648.htm", - "signature": "status.operation.setmap(bitNumber, setEvent, clearEvent)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to map events to bits in the Operation Event Register.", - "details": "You can map events to bits in the event registers with this command. This allows you to cause bits in the condition and event registers to be set or cleared when the specified events occur. You can use any valid event number as the event that sets or clears bits.When a mapped event is programmed to set bits, the corresponding bits in both the condition register and event register are set when the event is detected.When a mapped event is programmed to clear bits, the bit in the condition register is set to 0 when the event is detected.If the event is set to zero (0), the bit is never set.", - "param_info": [ - { - "name": "bitNumber", - "description": "The bit number that is mapped to an event (0 to 14)", - "enum": "", - "type": "integer", - "range": "(0 to 14)" - }, - { - "name": "setEvent", - "description": "The number of the event that sets the bits in the condition and event registers; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "clearEvent", - "description": "The number of the event that clears the bit in the condition register; 0 if no mapping", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "status.operation.setmap(bitNumber, setEvent)", - "status.operation.setmap(bitNumber, setEvent, clearEvent)" - ], - "overloads": [ - "status.operation.setmap(bitNumber, setEvent)" - ], - "examples": [ - { - "example": "status.operation.setmap(0, 2731, 2732);", - "description": "When event 2731 (trigger model initiated) occurs, bit 0 in the condition and event registers of the Operation Event Register are set. When event 2732 (trigger model idled) occurs, bit 0 in the condition register is cleared.\n" - } - ], - "related_commands": [ - "Operation Event Register", - "Programmable status register sets", - "status.operation.getmap()" - ] - }, - { - "name": "status.standard.event", - "webhelpfile": "31653.htm", - "signature": "", - "command_return": "standardRegister", - "type": "Attribute (R)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the contents of the Standard Event Status Register set of the status model.", - "details": "When this command returns zero (0), no bits are set. You can send 0 to clear all bits.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.Command errors include:", - "param_info": [ - { - "name": "standardRegister", - "description": "The status of the standard event status register", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "standardRegister = status.standard.event" - ], - "overloads": [], - "examples": [ - { - "example": "print(status.standard.event);", - "description": "May return the value 129, showing that the Standard Event Status Register contains binary 10000001\n" - } - ], - "related_commands": [ - "Standard Event Register" - ] - }, - { - "name": "status.request_enable", - "webhelpfile": "32386.htm", - "signature": "", - "command_return": "SRQEnableRegister", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the settings of the Service Request (SRQ) Enable Register.", - "details": "This command sets or clears the individual bits of the Status Request Enable Register.The Status Request Enable Register is cleared when power is cycled or when a parameter value of 0 is sent with this command.The instrument returns a decimal value that corresponds to the binary-weighted sum of all bits set in the register.", - "param_info": [ - { - "name": "SRQEnableRegister", - "description": "The status of the service request (SRQ) enable register; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings (0 to 255)", - "enum": "", - "type": "integer", - "range": "(SRQ)" - } - ], - "usage": [ - "SRQEnableRegister = status.request_enable", - "status.request_enable = SRQEnableRegister" - ], - "overloads": [], - "examples": [ - { - "example": "requestSRQEnableRegister = status.MSB + status.OSB;status.request_enable = requestSRQEnableRegister;", - "description": "Uses constants to set the MSB and OSB bits of the service request (SRQ) enable register and clear all other bits.\n" - }, - { - "example": "-- decimal 129 = binary 10000001;requestSRQEnableRegister = 129;status.request_enable = requestSRQEnableRegister;", - "description": "Uses a decimal value to set the MSB and OSB bits and clear all other bits of the service request (SRQ) enable register.\n" - }, - { - "example": "status.request_enable = 0;", - "description": "Clear the register.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "localnode.gettime()", - "webhelpfile": "32416.htm", - "signature": "localnode.gettime()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function retrieves the instrument date and time.", - "details": "The time is returned in UTC time. UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).", - "param_info": [ - { - "name": "print(os.date('%c', gettime()))", - "description": "Example output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "localnode.gettime()" - ], - "overloads": [], - "examples": [ - { - "example": "print(os.date('%c', gettime()));", - "description": "Example output:\n--- --Tue Dec 5 03:44:37 2017\n" - } - ], - "related_commands": [ - "localnode.settime()" - ] - }, - { - "name": "tsplink.line[N].mode", - "webhelpfile": "32538.htm", - "signature": "", - "command_return": "mode", - "type": "Attribute (RW)", - "default_value": "tsplink.MODE_DIGITAL_OPEN_DRAIN\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger operation of a TSP-Link line.", - "details": "This command defines whether or not the line is used as a digital or trigger control line and if it is an input or output.The line mode can be set to the following options:", - "param_info": [ - { - "name": "mode", - "description": "The trigger mode; see Details", - "enum": "", - "type": "tsplinkLineMode", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "mode = tsplink.line[N].mode", - "tsplink.line[N].mode = mode" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;", - "description": "Sets the trigger mode for synchronization line 3 as a trigger open drain line.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkout[N].logic" - ] - }, - { - "name": "trigger.tsplinkin[N].edge", - "webhelpfile": "32539.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates which trigger edge controls the trigger event detector for a trigger line.", - "details": "When the edge is detected, the instrument asserts a TTL-low pulse for the output.The output state of the I/O line is controlled by the trigger logic. The user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger mode", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggertsplinkinedgedetectedEdge", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "detectedEdge = trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[3].edge = trigger.EDGE_RISING;", - "description": "Sets synchronization line 3 to detect rising edge triggers as input.\n" - } - ], - "related_commands": [ - "digio.writeport()", - "tsplink.line[N].mode", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkout[N].logic", - "webhelpfile": "32540.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the trigger output with output logic for a trigger line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggertsplinkoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "logicType = trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].logic = trigger.LOGIC_POSITIVE;", - "description": "Sets the trigger logic for synchronization line 3 to output a positive pulse.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].reset()", - "webhelpfile": "32541.htm", - "signature": "tsplink.line[N].reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets some of the TSP-Link trigger attributes to their factory defaults.", - "details": "The tsplink.line[N].reset() function resets the following attributes to their default values:This also clears trigger.tsplinkin[N].overrun.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "tsplink.line[N].reset()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].reset();", - "description": "Resets TSP-Link trigger line\u00a03 attributes to default values.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].edge", - "trigger.tsplinkin[N].overrun", - "trigger.tsplinkout[N].logic", - "trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].stimulus", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.line[N].state", - "webhelpfile": "32542.htm", - "signature": "", - "command_return": "lineState", - "type": "Attribute (RW)", - "default_value": "tsplink.STATE_HIGH\n", - "tsp_link": "Yes\n", - "description": "This attribute reads or writes the digital state of a TSP-Link synchronization line.", - "details": "Use tsplink.writeport() to write to all TSP-Link synchronization lines.The reset function does not affect the present states of the TSP-Link trigger lines.", - "param_info": [ - { - "name": "lineState", - "description": "The state of the synchronization line", - "enum": "tsplink.STATE_LOW nil|tsplink.STATE_HIGH nil", - "type": "tsplinklinestatelineState", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "lineState = tsplink.line[N].state", - "tsplink.line[N].state = lineState" - ], - "overloads": [], - "examples": [ - { - "example": "lineState = tsplink.line[3].state;print(lineState);", - "description": "Assume line 3 is set high, and then the state is read.\n--- --Output:\n--- --tsplink.STATE_HIGH\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode", - "tsplink.writeport()" - ] - }, - { - "name": "trigger.tsplinkout[N].assert()", - "webhelpfile": "32549.htm", - "signature": "trigger.tsplinkout[N].assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function simulates the occurrence of the trigger and generates the corresponding trigger event.", - "details": "Initiates a trigger event and does not wait for completion. The set pulse width determines how long the trigger is asserted.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].assert()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[2].assert();", - "description": "Asserts trigger on trigger line 2.\n" - } - ], - "related_commands": [ - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].clear()", - "webhelpfile": "32551.htm", - "signature": "trigger.tsplinkin[N].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the event detector for a LAN trigger.", - "details": "The trigger event detector enters the detected state when an event is detected. When this command is sent, the instrument:", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3) to clear", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkin[N].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[2].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkin[2].clear();", - "description": "Clears the trigger event on TSP-Link line 2.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].overrun", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkin[N].overrun", - "webhelpfile": "32552.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the event detector ignored an event while in the detected state.", - "details": "This command indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the synchronization line itself.It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event. It also is not an indication of an output trigger overrun.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "overrun = trigger.tsplinkin[N].overrun" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkin[1].overrun);", - "description": "If an event on line 1 was ignored, displays true; if no additional event occurred, displays false.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.tsplinkout[N].pulsewidth", - "webhelpfile": "32553.htm", - "signature": "", - "command_return": "width", - "type": "Attribute (RW)", - "default_value": "10e-6 (10 \u00b5s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the length of time that the trigger line is asserted for output triggers.", - "details": "Setting the pulse width to 0 asserts the trigger indefinitely.", - "param_info": [ - { - "name": "width", - "description": "The pulse width (0.0 to 100 ks)", - "enum": "", - "type": "number", - "range": "(0.0 to 100 ks)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "width = trigger.tsplinkout[N].pulsewidth", - "trigger.tsplinkout[N].pulsewidth = width" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].pulsewidth = 20e-6;", - "description": "Sets pulse width for trigger line\u00a03 to 20\u00a0\u03bcs.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "trigger.tsplinkout[N].release()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].release()", - "webhelpfile": "32555.htm", - "signature": "trigger.tsplinkout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases a latched trigger on the given TSP-Link trigger line.", - "details": "Releases a trigger that was asserted with an indefinite pulse width. It also releases a trigger that was latched in response to receiving a synchronous mode trigger.", - "param_info": [ - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "trigger.tsplinkout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;trigger.tsplinkout[3].release();", - "description": "Releases trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].mode" - ] - }, - { - "name": "trigger.tsplinkout[N].stimulus", - "webhelpfile": "32558.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the event that causes the synchronization line to assert a trigger.", - "details": "To disable automatic trigger assertion on the synchronization line, set this attribute to trigger.EVENT_NONE.Do not use this attribute when triggering under script control. Use trigger.tsplinkout[N].assert() instead.The event parameters that you can use are described in the table below.", - "param_info": [ - { - "name": "event", - "description": "The event identifier for the triggering event (see Details)", - "enum": "", - "type": "triggerEvents", - "range": "(see Details)" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - } - ], - "usage": [ - "event = trigger.tsplinkout[N].stimulus", - "trigger.tsplinkout[N].stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "print(trigger.tsplinkout[3].stimulus);", - "description": "Outputs the event that will start action on TSP-Link trigger line 3.\n" - } - ], - "related_commands": [ - "trigger.tsplinkout[N].assert()", - "tsplink.line[N].reset()" - ] - }, - { - "name": "trigger.tsplinkin[N].wait()", - "webhelpfile": "32561.htm", - "signature": "trigger.tsplinkin[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function waits up to the timeout value for an input trigger. If one or more trigger events are detected since the last time this command or trigger.tsplinkin[N].clear() was called, this function returns immediately.After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication; set to one of the following values", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger line (1 to 3)", - "enum": "", - "type": "any", - "range": "(1 to 3)" - }, - { - "name": "timeout", - "description": "The timeout value in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.tsplinkin[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "tsplink.line[3].mode = tsplink.MODE_TRIGGER_OPEN_DRAIN;triggered = trigger.tsplinkin[3].wait(10);print(triggered);", - "description": "Waits up to 10 s for a trigger on TSP-Link line\u00a03.\n--- --If false is returned, no trigger was detected during the 10-s timeout.\n--- --If true is returned, a trigger was detected.\n" - } - ], - "related_commands": [ - "trigger.tsplinkin[N].clear()", - "tsplink.line[N].mode" - ] - }, - { - "name": "tsplink.master", - "webhelpfile": "32565.htm", - "signature": "", - "command_return": "masterNodeNumber", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute reads the node number assigned to the master node.", - "details": "This attribute returns the node number of the master in a set of instruments connected using TSP-Link.", - "param_info": [ - { - "name": "masterNodeNumber", - "description": "The node number of the master node (1 to 63)", - "enum": "", - "type": "number", - "range": "(1 to 63)" - } - ], - "usage": [ - "masterNodeNumber = tsplink.master" - ], - "overloads": [], - "examples": [ - { - "example": "LinkMaster = tsplink.master;", - "description": "Store the TSP-Link master node number in a variable called LinkMaster.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "localnode.version", - "webhelpfile": "32595.htm", - "signature": "", - "command_return": "version", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the firmware version of the instrument.", - "details": "This attribute indicates the version number of the firmware that is presently running in the instrument.", - "param_info": [ - { - "name": "version", - "description": "Instrument version level", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "version = localnode.version" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.version);", - "description": "Outputs the present version level. Example output:\n--- --1.0.0a\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.serialno" - ] - }, - { - "name": "localnode.serialno", - "webhelpfile": "32597.htm", - "signature": "", - "command_return": "serialno", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute stores the instrument's serial number.", - "details": "This indicates the instrument serial number.", - "param_info": [ - { - "name": "serialno", - "description": "The serial number of the instrument", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "serialno = localnode.serialno" - ], - "overloads": [], - "examples": [ - { - "example": "display.clear();display.settext(display.TEXT2, \"Serial #: \" ..localnode.serialno);display.changescreen(display.SCREEN_USER_SWIPE);", - "description": "Clears the instrument display.\n--- --Places the serial number of this instrument on the bottom line of the USER swipe screen display. Displays the USER swipe screen.\n" - } - ], - "related_commands": [ - "localnode.model", - "localnode.version" - ] - }, - { - "name": "localnode.linefreq", - "webhelpfile": "32628.htm", - "signature": "", - "command_return": "frequency", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the power line frequency setting that is used for NPLC calculations.", - "details": "The instrument automatically detects the power line frequency when the instrument is powered on. Power line frequency can be 50\u00a0Hz or 60\u00a0Hz.", - "param_info": [ - { - "name": "frequency", - "description": "The detected line frequency", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "frequency = localnode.linefreq" - ], - "overloads": [], - "examples": [ - { - "example": "frequency = localnode.linefreq;print(frequency);", - "description": "Reads the line frequency setting.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.tsp.runscript()", - "webhelpfile": "32684.htm", - "signature": "tspnet.tsp.runscript(connectionID, name, script)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function loads and runs a script on a remote TSP-enabled instrument.", - "details": "This function is appropriate only for TSP-enabled instruments.This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.The script is automatically loaded, compiled, and run.Any output from previous commands is discarded.This command does not wait for the script to complete.If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions later.", - "param_info": [ - { - "name": "connectionID", - "description": "Integer value used as an identifier for other tspnet commands", - "enum": "", - "type": "tspnetConnectionID", - "range": "" - }, - { - "name": "name", - "description": "The name that is assigned to the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "script", - "description": "The body of the script as a string", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "tspnet.tsp.runscript(connectionID, name, script)" - ], - "overloads": [], - "examples": [ - { - "example": "tspnet.tsp.runscript(myConnection, \"myTest\",;\"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])\");", - "description": "Load and run a script entitled myTest on the TSP-enabled instrument connected with myConnection.\n" - } - ], - "related_commands": [ - "tspnet.execute()" - ] - }, - { - "name": "dmm.measure.configlist.size()", - "webhelpfile": "32926.htm", - "signature": "dmm.measure.configlist.size(listName)", - "command_return": "indexCount", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the size (number of configuration indexes) of a measure configuration list.", - "details": "", - "param_info": [ - { - "name": "indexCount", - "description": "A number that represents the total count of indexes stored in the specified measure configuration list", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "listName", - "description": "A string that represents the name of a measure configuration list", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "indexCount = dmm.measure.configlist.size(listName)" - ], - "overloads": [], - "examples": [ - { - "example": "print(dmm.measure.configlist.size(\"testMeasList\"));", - "description": "Returns the number of configuration indexes in a measure configuration list named testMeasList.\n--- --Example output:\n--- --1\n" - } - ], - "related_commands": [ - "createconfigscript()", - "dmm.measure.configlist.create()" - ] - }, - { - "name": "localnode.access", - "webhelpfile": "33140.htm", - "signature": "", - "command_return": "accessType", - "type": "Attribute (RW)", - "default_value": "localnode.ACCESS_FULL\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the type of access users have to the instrument through different interfaces.", - "details": "When access is set to full, the instrument accepts commands from any interface with no login or password.When access is set to exclusive, you must log out of one remote interface and log into another one to change interfaces. You do not need a password with this access.Protected access is similar to exclusive access, except that you must enter a password when logging\u00a0in.When the access is set to locked out, a password is required to change interfaces, including the front-panel interface.Under any access type, if a script is running on one remote interface when a command comes in from another remote interface, the command is ignored and the message \"FAILURE: A script is running, use ABORT to stop it\" is generated.", - "param_info": [ - { - "name": "accessType", - "description": "The type of access", - "enum": "localnode.ACCESS_FULL nil|localnode.ACCESS_EXCLUSIVE nil|localnode.ACCESS_PROTECTED nil|localnode.ACCESS_LOCKOUT nil", - "type": "localnodeaccessaccessType", - "range": "" - } - ], - "usage": [ - "accessType = localnode.access", - "localnode.access = accessType" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.access = localnode.ACCESS_LOCKOUT;login admin;logout;", - "description": "Set the instrument access to locked out.\n--- --Log into the interface using the default password.\n--- --Log out of the interface.\n" - } - ], - "related_commands": [ - "localnode.password" - ] - }, - { - "name": "localnode.prompts", - "webhelpfile": "33148.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.DISABLE\n", - "tsp_link": "No\n", - "description": "This attribute determines if the instrument generates prompts in response to command messages.", - "details": "When the prompting mode is enabled, the instrument generates prompts when the instrument is ready to take another command. Because the prompt is not generated until the previous command completes, enabling prompts provides handshaking with the instrument to prevent buffer overruns.When prompting is enabled, the instrument might generate the following prompts:Commands do not generate prompts. The instrument generates prompts in response to command completion.Prompts are enabled or disabled only for the remote interface that is active when you send the command. For example, if you enable prompts when the LAN connection is active, they will not be enabled for a subsequent USB connection.", - "param_info": [ - { - "name": "prompting", - "description": "Do not generate prompts", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodepromptsprompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts", - "localnode.prompts = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts = localnode.ENABLE;", - "description": "Enable prompting.\n" - } - ], - "related_commands": [ - "tsplink.initialize()" - ] - }, - { - "name": "trigger.lanout[N].logic", - "webhelpfile": "33157.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the logic on which the trigger event detector and the output trigger generator operate on the given trigger line.", - "details": "", - "param_info": [ - { - "name": "logicType", - "description": "The type of logic", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerlanoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "The LAN event number (1 to 8)", - "enum": "", - "type": "any", - "range": "(1 to 8)" - } - ], - "usage": [ - "logicType = trigger.lanout[N].logic", - "trigger.lanout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.lanout[2].logic = trigger.LOGIC_POSITIVE;", - "description": "Set the logic for LAN trigger line 2 to positive.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.digout[N].logic", - "webhelpfile": "33159.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the output logic of the trigger event generator to positive or negative for the specified line.", - "details": "This attribute controls the logic that the output trigger generator uses on the given trigger line.The output state of the digital I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerdigoutlogiclogicType", - "range": "" - }, - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "logicType = trigger.digout[N].logic", - "trigger.digout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].logic = trigger.LOGIC_NEGATIVE;", - "description": "Sets line 4 mode to be a trigger output and sets the output logic of the trigger event generator to negative (asserts a low pulse).\n" - } - ], - "related_commands": [ - "digio.line[N].mode", - "digio.line[N].reset()" - ] - }, - { - "name": "bufferVar.statuses", - "webhelpfile": "33164.htm", - "signature": "bufferVar.statuses[N]", - "command_return": "statusInformation", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the status values of readings in the reading buffer.", - "details": "This command is not available if the buffer style is set to compact.This read-only attribute is an array of status values for the readings in the buffer. The status values are floating-point numbers that encode the status value. Refer to the following table for values.", - "param_info": [ - { - "name": "statusInformation", - "description": "The status value when reading N of the specified buffer was acquired; refer to Details", - "enum": "", - "type": "bufferVarstatuses", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "any", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "statusInformation = bufferVar.statuses[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset() ;testData = buffer.make(50);trigger.model.load(\"SimpleLoop\", 2, 0, testData);trigger.model.initiate();waitcomplete();printbuffer(1, 2, testData.statuses);", - "description": "Create a reading buffer named testData, configure the instrument to make two measurements, and store the readings in the buffer.\n--- --Print the status for the readings in testData.\n--- --Output:\n--- --64, 64\n--- --Indicating that the status is buffer.STAT_LIMIT1_LOW.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.delete()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "buffer.save()", - "webhelpfile": "33210.htm", - "signature": "buffer.save(bufferVar, fileName, what, start, end)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function saves data from the specified reading buffer to a USB flash drive.", - "details": "The file name must specify the full path (including /usb1/). If included, the file extension must be set to .csv. If no file extension is specified, .csv is added.Examples of valid destination file names:The DMM7510 does not check for existing files when you save. Verify that you are using a unique name to avoid overwriting any existing CSV files on the flash drive.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "fileName", - "description": "A string that indicates the name of the file on the USB flash drive in which to save the reading buffer", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "what", - "description": "Defines which information is saved in the file on the USB flash drive", - "enum": "", - "type": "bufferFileSaveDetails", - "range": "" - }, - { - "name": "start", - "description": "Defines the starting point in the buffer to start saving data", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "end", - "description": "Defines the ending point in the buffer to stop saving data", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, what)", - "buffer.save(bufferVar, fileName, what, start, end)" - ], - "overloads": [ - "buffer.save(bufferVar, fileName)", - "buffer.save(bufferVar, fileName, what)" - ], - "examples": [ - { - "example": "buffer.save(MyBuffer, \"/usb1/myData.csv\");", - "description": "Save all reading and default time information from a buffer named MyBuffer to a file named myData.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(MyBuffer, \"/usb1/myDataRel.csv\", buffer.SAVE_RELATIVE_TIME);", - "description": "Save all readings and relative timestamps from MyBuffer to a file named myDataRel.csv on the USB flash drive.\n" - }, - { - "example": "buffer.save(defbuffer1, \"/usb1/defbuf1data\", buffer.SAVE_RAW_TIME);", - "description": "Save readings and raw time stamps from defbuffer1 to a file named defbuf1data on the USB flash drive.\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.saveappend()" - ] - }, - { - "name": "display.prompt()", - "webhelpfile": "33260.htm", - "signature": "display.prompt(buttonID, promptText)", - "command_return": "promptID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an interactive dialog prompt that displays a custom message on the front-panel display.", - "details": "This command displays buttons and text on the front panel. You can set up scripts that respond to the buttons when they are selected.If you send display.BUTTONS_NONE, the operator needs to press the EXIT key to clear the message from the front-panel display. You can also use the display.delete() command to remove the prompt.Only one prompt can be active at a time.When the user presses a button, the button presses are returned as one of the following options:To capture return values, you need to use display.waitevent() to wait for the user button selection.", - "param_info": [ - { - "name": "promptID", - "description": "A set of characters that identifies the prompt; up to 63 characters", - "enum": "", - "type": "promptID", - "range": "" - }, - { - "name": "buttonID", - "description": "The type of prompt to display; choose one of the following options", - "enum": "display.BUTTONS_NONE nil|display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displaypromptbuttonID", - "range": "" - }, - { - "name": "promptText", - "description": "A string that contains the text that is displayed above the prompts", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "promptID = display.prompt(buttonID, promptText)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 10, 0, defbuffer1);display.prompt(display.BUTTONS_YESNO, \"Would you like to make 10 DC voltage readings now?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then;\u00a0\u00a0 trigger.model.initiate();end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a simple loop that will make 10 measurements and save them in default buffer 1.\n--- --Display the prompt shown here:\n--- --\n--- --If the user presses Yes, the measurements are made.\n--- --If the user presses No, the measurements are not made, and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.delete()", - "display.waitevent()" - ] - }, - { - "name": "display.waitevent()", - "webhelpfile": "33261.htm", - "signature": "display.waitevent(timeout)", - "command_return": "objectID, subID", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to wait for a user to respond to a prompt that was created with a prompt command.", - "details": "This command waits until a user responds to a front-panel prompt that was created with the display.prompt() command.", - "param_info": [ - { - "name": "objectID", - "description": "A number that identifies the object, such as a prompt message, that is displayed on the front panel", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "subID", - "description": "The returned value after a button is pressed on the front panel", - "enum": "display.BUTTON_YES nil|display.BUTTON_NO nil|display.BUTTON_OK nil|display.BUTTON_CANCEL nil", - "type": "displaywaiteventsubID", - "range": "" - }, - { - "name": "timeout", - "description": "The amount of time to wait before timing out; time is 0 to 300 s, where the default of 0 waits indefinitely", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "objectID, subID = display.waitevent()", - "objectID, subID = display.waitevent(timeout)" - ], - "overloads": [ - "objectID, subID = display.waitevent()" - ], - "examples": [ - { - "example": "reset();trigger.model.load(\"SimpleLoop\", 10, 0, defbuffer1);display.prompt(display.BUTTONS_YESNO, \"Would you like to make 10 DC voltage readings now?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then;\u00a0\u00a0 trigger.model.initiate();end;display.prompt(display.BUTTONS_YESNO, \"Would you like to switch to the Graph screen?\");promptID, result = display.waitevent();if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "Create a simple loop that will make 10 measurements and save them in default buffer 1.\n--- --Display the prompt \"Would you like to make 10 DC voltage readings now?\"\n--- --If the user presses Yes, the measurements are made.\n--- --If the user presses No, the measurements are not made and the message is removed.\n--- --Display the prompt \"Would you like to switch to the Graph screen?\"\n--- --If the user presses Yes, the Graph screen is displayed.\n--- --If the user presses No, the user remains on the present screen.\n" - } - ], - "related_commands": [ - "display.input.prompt()", - "display.prompt()" - ] - }, - { - "name": "script.load()", - "webhelpfile": "33286.htm", - "signature": "script.load(file)", - "command_return": "scriptVar", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a script from a specified file.", - "details": "The name that is used for scriptVar must not already exist as a global variable. In addition, the scriptVar name must be a global reference and not a local variable, table, or array.For external scripts, the root folder of the USB flash drive has the absolute path /usb1/.", - "param_info": [ - { - "name": "file", - "description": "A string that contains the path and file name of the script file to load; if scriptVar is not defined, this name is used as the global variable name for this script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The created script; a global variable with this name is used to reference the script", - "enum": "", - "type": "scriptVar", - "range": "" - } - ], - "usage": [ - "script.load(file)", - "scriptVar = script.load(file)" - ], - "overloads": [ - "script.load(file)" - ], - "examples": [ - { - "example": "test8 = script.load(\"/usb1/testSetup.tsp\");", - "description": "Loads the script with the file name testSetup.tsp that is on the USB flash drive and names it test8.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.catalog()", - "webhelpfile": "33290.htm", - "signature": "for name in script.catalog() do body end", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.", - "details": "This function accesses the catalog of scripts stored in nonvolatile memory, which allows you to process all scripts in nonvolatile memory. The entries are enumerated in no particular order.Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.", - "param_info": [ - { - "name": "name", - "description": "String representing the name of the script returned from script.catalog()", - "enum": "", - "type": "any", - "range": "()" - }, - { - "name": "body", - "description": "Code that implements the body of the for loop to process the return names from the catalog command", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "for name in script.catalog() do body end" - ], - "overloads": [], - "examples": [ - { - "example": "for name in script.catalog() do; print(name);end;", - "description": "Retrieve the catalog listing for user scripts.\n--- --print(name) represent the body parameter shown in the Usage.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "script.delete()", - "webhelpfile": "33394.htm", - "signature": "script.delete(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function deletes a script from the run-time memory and nonvolatile memory.", - "details": "When a script is deleted, the global variable referring to this script is also deleted.You must delete an existing script before you can use the name of that script again. Scripts are not automatically overwritten.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "script.delete(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "script.delete(\"test8\");", - "description": "Deletes a user script named test8 from nonvolatile memory and the global variable named test8.\n" - } - ], - "related_commands": [ - "Deleting a user script using a remote interface", - "scriptVar.save()" - ] - }, - { - "name": "scriptVar.source", - "webhelpfile": "33395.htm", - "signature": "", - "command_return": "code", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the source code of a script.", - "details": "The body of the script is a single string with lines separated by the new line character.", - "param_info": [ - { - "name": "code", - "description": "The body of the script", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "scriptVar", - "description": "The name of the variable that references the script that contains the source code", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "code = scriptVar.source" - ], - "overloads": [], - "examples": [ - { - "example": "print(test7.source);", - "description": "Assuming a script named test7 was created on the instrument, this example retrieves the source code.\n--- --Output:\n--- --reset()\n--- --display.settext(display.TEXT1, \"Text on line 1\")\n--- --display.settext(display.TEXT2, \"Text on line 2\")\n" - } - ], - "related_commands": [ - "scriptVar.save()" - ] - }, - { - "name": "display.lightstate", - "webhelpfile": "33459.htm", - "signature": "", - "command_return": "brightness", - "type": "Attribute (RW)", - "default_value": "display.STATE_LCD_50\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the light output level of the front-panel display.", - "details": "This command changes the light output of the front panel when a test requires different instrument illumination levels.The change in illumination is temporary. The normal backlight settings are restored after a power cycle. You can use this to reset a display that is already dimmed by the front-panel Backlight Dimmer.", - "param_info": [ - { - "name": "brightness", - "description": "The brightness of the display", - "enum": "display.STATE_LCD_100 nil|display.STATE_LCD_75 nil|display.STATE_LCD_50 nil|display.STATE_LCD_25 nil|display.STATE_LCD_OFF nil|display.STATE_BLACKOUT nil", - "type": "displaylightstatebrightness", - "range": "" - } - ], - "usage": [ - "brightness = display.lightstate", - "display.lightstate = brightness" - ], - "overloads": [], - "examples": [ - { - "example": "display.lightstate = display.STATE_LCD_50;", - "description": "Set the display brightness to 50%.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "status.preset()", - "webhelpfile": "33635.htm", - "signature": "status.preset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets all bits in the status model.", - "details": "This function clears the event registers and the enable registers for operation and questionable. It will not clear the Service Request Enable Register (*SRE) to Standard Request Enable Register (*ESE).Preset does not affect the event queue.The Standard Event Status Register is not affected by this command.", - "param_info": [ - { - "name": "status.preset()", - "description": "Resets the instrument status model.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "status.preset()" - ], - "overloads": [], - "examples": [ - { - "example": "status.preset();", - "description": "Resets the instrument status model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "buffer.delete()", - "webhelpfile": "33981.htm", - "signature": "buffer.delete(bufferName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function deletes a user-defined reading buffer.", - "details": "You cannot delete the default reading buffers, defbuffer1 and defbuffer2.After deleting the buffer, call collectgarbage() to reclaim the memory the buffer was using.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of a user-defined reading buffer", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "buffer.delete(bufferName)" - ], - "overloads": [], - "examples": [ - { - "example": "buf400\u00a0= buffer.make(400);dmm.measure.read(buf400);printbuffer(1, buf400.n, buf400.relativetimestamps);buffer.delete(buf400);collectgarbage();", - "description": "Create a 400-element reading buffer named buf400.\n--- --Make measurements and store the readings in buf400.\n--- --Print the relative timestamps for each reading in the buffer.\n--- --Example output, assuming five readings are stored in the buffer:\n--- --0, 0.412850017, 0.821640085, 1.230558058, 1.629523236\n--- --Delete buf400.\n--- --Use collectgarbage() to unallocate the buffer.\n" - } - ], - "related_commands": [ - "buffer.make()", - "bufferVar.clear()", - "printbuffer()" - ] - }, - { - "name": "trigger.timer[N].start.seconds", - "webhelpfile": "33984.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.seconds", - "trigger.timer[N].start.seconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.seconds = localnode.gettime() + 30;trigger.timer[1].enable = trigger.ON;", - "description": "Set the trigger timer to start 30 s from the time when the timer is enabled.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.timer[N].start.fractionalseconds", - "webhelpfile": "33985.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the fractional seconds of an alarm or a time in the future when the timer will start.", - "details": "This command configures the alarm of the timer.When the timer is enabled, the timer starts immediately if the timer is configured for a start time that has passed.", - "param_info": [ - { - "name": "time", - "description": "The time in fractional seconds (0 to <1 s)", - "enum": "", - "type": "number", - "range": "(0 to <1 s)" - }, - { - "name": "N", - "description": "Trigger timer number (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "time = trigger.timer[N].start.fractionalseconds", - "trigger.timer[N].start.fractionalseconds = time" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.timer[1].start.fractionalseconds = 0.4;", - "description": "Set the trigger timer to start in 0.4\u00a0s.\n" - } - ], - "related_commands": [ - "trigger.timer[N].start.generate" - ] - }, - { - "name": "reset()", - "webhelpfile": "34054.htm", - "signature": "reset(system)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function resets commands to their default settings and clears the buffers.", - "details": "The reset() command in its simplest form resets the entire TSP-enabled system, including the controlling node and all subordinate nodes.If you want to reset a specific instrument, use the node[N].reset() command. Also use the node[N].reset() command to reset an instrument on a subordinate node.When no value is specified for system, the default value is true.You can only reset the entire system using reset(true) if the node is the master. If the node is not the master node, executing this command generates an error event.", - "param_info": [ - { - "name": "system", - "description": "If the node is the master, the entire system is reset", - "enum": "", - "type": "boolean", - "range": "" - } - ], - "usage": [ - "reset()", - "reset(system)" - ], - "overloads": [ - "reset()" - ], - "examples": [ - { - "example": "reset(true);", - "description": "If the node is the master node, the entire system is reset; if the node is not the master node, an error event is generated.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "tspnet.termination()", - "webhelpfile": "34363.htm", - "signature": "tspnet.termination(connectionID, termSequence)", - "command_return": "type", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function sets the device line termination sequence.", - "details": "This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP-enabled, the default is tspnet.TERM_CRLF.", - "param_info": [ - { - "name": "type", - "description": "The termination type", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtype", - "range": "" - }, - { - "name": "connectionID", - "description": "The connection ID returned from tspnet.connect()", - "enum": "", - "type": "tspnetConnectionID", - "range": "()" - }, - { - "name": "termSequence", - "description": "The termination sequence", - "enum": "tspnet.TERM_LF nil|tspnet.TERM_CR nil|tspnet.TERM_CRLF nil|tspnet.TERM_LFCR nil", - "type": "tspnetterminationtermSequence", - "range": "" - } - ], - "usage": [ - "type = tspnet.termination(connectionID)", - "type = tspnet.termination(connectionID, termSequence)" - ], - "overloads": [ - "type = tspnet.termination(connectionID)" - ], - "examples": [ - { - "example": "deviceID = tspnet.connect(\"192.0.2.1\");if deviceID then; tspnet.termination(deviceID, tspnet.TERM_LF);end;", - "description": "Sets termination type for IP address 192.0.2.1 to TERM_LF.\n" - } - ], - "related_commands": [ - "tspnet.connect()", - "tspnet.disconnect()" - ] - }, - { - "name": "trigger.blender[N].stimulus[M]", - "webhelpfile": "34428.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the events that trigger the blender.", - "details": "There are four stimulus inputs that can each select a different event.Use none to disable the blender input.The event parameter may be any of the trigger events shown in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event that triggers the blender action; see Details", - "enum": "", - "type": "triggerEvents[]", - "range": "" - }, - { - "name": "N", - "description": "An integer that represents the trigger event blender (up to two)", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "M", - "description": "An integer representing the stimulus index (1 to 4)", - "enum": "", - "type": "any", - "range": "(1 to 4)" - } - ], - "usage": [ - "event = trigger.blender[N].stimulus[M]", - "trigger.blender[N].stimulus[M] = event" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n" - } - ], - "related_commands": [ - "trigger.blender[N].reset()" - ] - }, - { - "name": "buffer.clearstats()", - "webhelpfile": "34560.htm", - "signature": "buffer.clearstats(bufferVar)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the statistical information associated with the specified buffer.", - "details": "This command clears the statistics without clearing the readings.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1 if not specified", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "buffer.clearstats()", - "buffer.clearstats(bufferVar)" - ], - "overloads": [ - "buffer.clearstats()" - ], - "examples": [ - { - "example": "buffer.clearstats();", - "description": "Clears statistics for defbuffer1.\n" - } - ], - "related_commands": [ - "buffer.getstats()" - ] - }, - { - "name": "createconfigscript()", - "webhelpfile": "34589.htm", - "signature": "createconfigscript(scriptName)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function creates a setup file that captures most of the present settings of the instrument.", - "details": "This function does not automatically overwrite existing scripts with the same name. If scriptName is set to the name of an existing script, an event message is returned. You must delete the existing script before using the same script name. This includes the autoexec script, which runs automatically when the instrument power is turned on. You can set scriptName to autoexec, but you must delete the existing autoexec script first using the script.delete(\"autoexec\") command.Once created, the script that contains the settings can be run and edited like any other script.", - "param_info": [ - { - "name": "scriptName", - "description": "A string that represents the name of the script that will be created", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "createconfigscript(scriptName)" - ], - "overloads": [], - "examples": [ - { - "example": "createconfigscript(\"myConfigurationScript\");reset();myConfigurationScript();", - "description": "Capture the present settings of the instrument into a script named myConfigurationScript.\n--- --Reset the instrument.\n--- --Restore the settings stored in myConfigurationScript.\n" - } - ], - "related_commands": [ - "Saving setups", - "script.delete()" - ] - }, - { - "name": "localnode.password", - "webhelpfile": "34629.htm", - "signature": "", - "command_return": "password", - "type": "Attribute (W)", - "default_value": "\"admin\"\n", - "tsp_link": "No\n", - "description": "This attribute stores the instrument password.", - "details": "When the access to the instrument is set to protected or lockout, this is the password that is used to gain access.If you forget the password, you can reset the password to the default:You can also reset the password and the LAN settings from the rear panel by inserting a straightened paper clip into hole below LAN RESET.", - "param_info": [ - { - "name": "password", - "description": "A string that contains the instrument password (maximum 30 characters)", - "enum": "", - "type": "string", - "range": "(maximum 30 characters)" - } - ], - "usage": [ - "localnode.password = password" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.password = \"N3wpa55w0rd\";", - "description": "Changes the password to N3wpa55w0rd.\n" - } - ], - "related_commands": [ - "localnode.access" - ] - }, - { - "name": "eventlog.post()", - "webhelpfile": "34730.htm", - "signature": "eventlog.post(message, eventType)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to post your own text to the event log.", - "details": "You can use this command to create your own event log entries and assign a severity level to them. This can be useful for debugging and status reporting.From the front panel, you must set the Log Warnings and Log Information options on to have the custom warning and information events placed into the event log.You can send use the following codes to create special characters in the message.", - "param_info": [ - { - "name": "message", - "description": "String that contains the message", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "eventType", - "description": "The type of event; if no event is defined, defaults to eventlog.SEV_INFO", - "enum": "eventlog.SEV_INFO nil|eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil", - "type": "eventlogposteventType", - "range": "" - } - ], - "usage": [ - "eventlog.post(message)", - "eventlog.post(message, eventType)" - ], - "overloads": [ - "eventlog.post(message)" - ], - "examples": [ - { - "example": "eventlog.clear();eventlog.post(\"Results in \\018\", eventlog.SEV_ERROR);print(eventlog.next());", - "description": "Posts an event that states \"Results in \u03a9\".\n--- --Output:\n--- --1005 User: Results in \u03a9\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "file.usbdriveexists()", - "webhelpfile": "34905.htm", - "signature": "file.usbdriveexists()", - "command_return": "driveInserted", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function detects if a USB flash drive is inserted into the front-panel USB port.", - "details": "You can call this command from a script to verify that a USB flash drive is inserted before attempting to write data to it.", - "param_info": [ - { - "name": "driveInserted", - "description": "0", - "enum": "", - "type": "0|1", - "range": "" - } - ], - "usage": [ - "driveInserted = file.usbdriveexists()" - ], - "overloads": [], - "examples": [ - { - "example": "local response;local xMax = 10;\u00a0;for x = 1, xMax do; -- Make xMax readings and store them in defbuffer1.; dmm.measure.read();end;\u00a0;if (file.usbdriveexists() == 1) then ; response = display.BUTTON_YES;else; response = display.input.prompt(display.BUTTONS_YESNO, \"Insert a USB flash drive.\\nPress Yes to write data or No to not write data.\") ;end;\u00a0;if (response == display.BUTTON_YES) then; if (file.usbdriveexists() == 1) then ; FileNumber = file.open(\"/usb1/TenReadings.csv\", file.MODE_WRITE); file.write(FileNumber,\"Reading,Seconds\\n\");\u00a0; -- Print out the measured values in a two-column format.; print(\"\\nIteration:\\tReading:\\tTime:\\n\");\u00a0; for i = 1, xMax do; print(i, defbuffer1[i], defbuffer1.relativetimestamps[i]); file.write(FileNumber, string.format(\"%g, %g\\r\\n\",defbuffer1.readings[i], defbuffer1.relativetimestamps[i])); end; file.close(FileNumber); else; response = display.input.prompt(display.BUTTONS_OK,; \"No drive detected. Allow more time after inserting a drive.\") ; end;end;", - "description": "Make measurements.\n--- --Verify that a flash drive is inserted into the instrument.\n--- --If the flash drive is inserted, write the data to the flash drive.\n--- --Print data into a two-column format.\n--- --If the flash drive is not inserted after selecting Yes, another prompt is displayed.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.blender[N].wait()", - "webhelpfile": "35118.htm", - "signature": "trigger.blender[N].wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a blender trigger event to occur.", - "details": "This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detection indication for blender", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "N", - "description": "The trigger blender (up to two) on which to wait", - "enum": "", - "type": "any", - "range": "(up to two)" - }, - { - "name": "timeout", - "description": "Maximum amount of time in seconds to wait for the trigger blender event", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.blender[N].wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "digio.line[3].mode = digio.MODE_TRIGGER_IN;digio.line[5].mode = digio.MODE_TRIGGER_IN;trigger.digin[3].edge = trigger.EDGE_FALLING;trigger.digin[5].edge = trigger.EDGE_FALLING;trigger.blender[1].orenable = true;trigger.blender[1].stimulus[1] = trigger.EVENT_DIGIO3;trigger.blender[1].stimulus[2] = trigger.EVENT_DIGIO5;print(trigger.blender[1].wait(3));", - "description": "Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.\n--- --Wait 3 s while checking if trigger blender 1 event has occurred.\n" - } - ], - "related_commands": [ - "trigger.blender[N].clear()" - ] - }, - { - "name": "trigger.model.load() - ConfigList", - "webhelpfile": "35126.htm", - "signature": "trigger.model.load(ConfigList, measureConfigList, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that uses a measure configuration list.", - "details": "This trigger-model template incorporates a configuration list. You must set up the configuration lists before loading the trigger model. If the configuration lists change, you must resend this command.You can also set a delay and change the reading buffer.The out line of the EXT TRIG IN/OUT rear-panel terminal is asserted at the end of each measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.", - "param_info": [ - { - "name": "ConfigList", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "measureConfigList", - "description": "A string that contains the name of the measurement configuration list to use", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1.", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(ConfigList, measureConfigList)", - "trigger.model.load(ConfigList, measureConfigList, delay)", - "trigger.model.load(ConfigList, measureConfigList, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(ConfigList, measureConfigList)", - "trigger.model.load(ConfigList, measureConfigList, delay)" - ], - "examples": [ - { - "example": "reset();dmm.measure.func = dmm.FUNC_AC_CURRENT;dmm.measure.configlist.create(\"MEASURE_LIST\");dmm.measure.range = 1e-3;dmm.measure.configlist.store(\"MEASURE_LIST\");dmm.measure.range = 10e-3;dmm.measure.configlist.store(\"MEASURE_LIST\");dmm.measure.range = 100e-3;dmm.measure.configlist.store(\"MEASURE_LIST\");trigger.model.load(\"ConfigList\", \"MEASURE_LIST\");trigger.model.initiate();waitcomplete();printbuffer(1, defbuffer1.n, defbuffer1.readings);", - "description": "Reset the instrument.Set the measure function to AC current.\n--- --Set up a configuration list named MEASURE_LIST.\n--- --Load the configuration list trigger model, using the indexes in this configuration list.\n--- --Start the trigger model.\n--- --Wait for the trigger model to complete.\n--- --Return the results from the reading buffer.\n--- --Example output:\n--- --9.9246953126e-07, 6.9921188254e-06, 3.8904102673e-05\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - Empty", - "webhelpfile": "35127.htm", - "signature": "trigger.model.load(Empty)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger model.", - "details": "When you load this trigger-model template, any blocks that have been defined in the trigger model are cleared so the trigger model has no blocks defined.", - "param_info": [ - { - "name": "Empty", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "trigger.model.load(\"Empty\")print(trigger.model.getblocklist())", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Clear the trigger model to have no blocks defined.Output:EMPTY", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.load(Empty)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");print(trigger.model.getblocklist());", - "description": "Clear the trigger model to have no blocks defined.\n--- --Output:\n--- --EMPTY\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LogicTrigger", - "webhelpfile": "35128.htm", - "signature": "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a logic trigger through the digital or external I/O.", - "details": "This trigger model waits for a digital input or external trigger input event to occur, makes a measurement, and issues a notify event. If a digital output line is selected, a notify event asserts a digital output line. A notify event asserts the external trigger output line regardless of the line settings. You can set the line to 7 to assert only the external trigger output line, or to another setting to assert both a digital output line and the external trigger output line.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.This command replaces the trigger.model.load() \u2014 ExtDigTrigger command, which is deprecated.The following usage has been deprecated; replace it with the usage above that includes the clear parameter.trigger.model.load(\"LogicTrigger\", digInLine, digOutLine, count)trigger.model.load(\"LogicTrigger\", digInLine, digOutLine, count, delay)trigger.model.load(\"LogicTrigger\", digInLine, digOutLine, count, delay, bufferName)trigger.model.load(\"LogicTrigger\", digInLine, digOutLine, count, delay, bufferName, readingBlock)", - "param_info": [ - { - "name": "LogicTrigger", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "digInLine", - "description": "The digital input line (1 to 6) or external input line (7); also, the event that the trigger model will wait on in block\u00a01", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "digOutLine", - "description": "The digital output line (1 to 6) or external input line (7)", - "enum": "", - "type": "number", - "range": "(1 to 6)" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLogicTriggerclear", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear)", - "trigger.model.load(LogicTrigger, digInLine, digOutLine, count, clear, delay)" - ], - "examples": [ - { - "example": "trigger.model.load(\"LogicTrigger\", 7, 2, 10, 0.001, defbuffer1);", - "description": "Set up the template to use the external in line and wait for a pulse from the external in to trigger measurements.\n--- --Pulse digital output line 2 and external trigger out when the measurement is complete.\n--- --Make 10 measurements, with a delay of 1\u00a0ms before each measurement.\n--- --Store the measurements in defbuffer1.\n" - } - ], - "related_commands": [ - "trigger.digout[N].logic" - ] - }, - { - "name": " trigger.BLOCK_LOG_EVENT", - "webhelpfile": "35428.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to log an event in the event log when the trigger model is running.", - "details": "Note that using this block too often in a trigger model could overflow the event log. It may also take away from the time needed to process more critical trigger model blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "eventNumber", - "description": "The event number", - "enum": "trigger.LOG_INFO nil|trigger.LOG_WARN nil|trigger.LOG_ERROR nil|trigger.LOG_WARN_ABORT nil", - "type": "triggermodelsetblocktriggerBLOCK_LOG_EVENTeventNumber", - "range": "" - }, - { - "name": "message", - "description": "A string up to 31 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_LOG_EVENT, eventNumber, message)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(9, trigger.BLOCK_LOG_EVENT, trigger.LOG_INFO2, \"Trigger model complete.\");", - "description": "Set trigger model block 9 to log an event when the trigger model completes. In the event log, the message is:\n--- --TM #1 block #9 logged: Trigger model complete.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": " trigger.BLOCK_NOP", - "webhelpfile": "35431.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a placeholder that performs no action in the trigger model; available only using remote commands.", - "details": "If you remove a trigger model block, you can use this block as a placeholder for the block number so that you do not need to renumber the other blocks.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_NOP)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.setblock(4, trigger.BLOCK_NOP);", - "description": "Set block number 4 to be a no operation block.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dmm.reset()", - "webhelpfile": "35753.htm", - "signature": "dmm.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets commands that begin with dmm. to their default settings.", - "details": "", - "param_info": [ - { - "name": "dmm.reset()", - "description": "Resets the DMM commands to their default settings.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.reset();", - "description": "Resets the DMM commands to their default settings.\n" - } - ], - "related_commands": [ - "reset()" - ] - }, - { - "name": "display.delete()", - "webhelpfile": "38977.htm", - "signature": "display.delete(promptID)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to remove a prompt on the front-panel display that was created with display.prompt().", - "details": "You can use this command to remove the presently displayed prompt.", - "param_info": [ - { - "name": "promptID", - "description": "The identifier defined by display.prompt()", - "enum": "", - "type": "promptID", - "range": "()" - } - ], - "usage": [ - "display.delete(promptID)" - ], - "overloads": [], - "examples": [ - { - "example": "removePrompt3 = display.prompt(display.BUTTONS_NONE, \"This prompt will disappear in 3 seconds\");delay(3);display.delete(removePrompt3);", - "description": "This example displays a prompt that is automatically removed in three seconds.\n--- --\n--- --\u00a0\n" - } - ], - "related_commands": [ - "display.prompt()" - ] - }, - { - "name": "eventlog.suppress()", - "webhelpfile": "40049.htm", - "signature": "eventlog.suppress(eventNumber)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This command allows you to suppress system events from generating a popup on the front\u2011panel interface.", - "details": "The eventType parameter allows you to suppress groups of events (errors, warnings, and information). You can combine the event types to suppress more than one type. For example, to suppress information and error events, send the command:You can use the eventNumber parameter to suppress individual system This command does not prevent system events from appearing in the event log or in a file on a USB flash drive.An event number is the number that accompanies an error, warning, or information message that is reported in the event log. For example, for the error \"Error -109, Missing parameter,\" the event number is \u2013109. Note that some messages that are displayed on the front panel are not recorded in the event log. Only messages that include an event number can be suppressed.", - "param_info": [ - { - "name": "eventType", - "description": "The type of the event to be suppressed", - "enum": "eventlog.SEV_ERROR nil|eventlog.SEV_WARN nil|eventlog.SEV_INFO nil|eventlog.SEV_ALL nil", - "type": "eventlogsuppresseventType", - "range": "" - }, - { - "name": "eventNumber", - "description": "The number of a specific event to be suppressed", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "eventlog.suppress(eventType)", - "eventlog.suppress(eventNumber)" - ], - "overloads": [ - "eventlog.suppress(eventType)" - ], - "examples": [ - { - "example": "eventlog.suppress(-109);", - "description": "Suppress -109, the missing parameter message, from displaying a popup on the front panel.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "display.input.number()", - "webhelpfile": "40051.htm", - "signature": "display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)", - "command_return": "numberEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that requests a number from the user on the front-panel display.", - "details": "This command prompts the instrument operator to enter a value.The prompt is displayed until it has been responded to.", - "param_info": [ - { - "name": "numberEntered", - "description": "The number that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; can be up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "numberFormat", - "description": "The format of the displayed number", - "enum": "display.NFORMAT_INTEGER nil|display.NFORMAT_DECIMAL nil|display.NFORMAT_EXPONENT nil|display.NFORMAT_PREFIX nil", - "type": "displayinputnumbernumberFormat", - "range": "" - }, - { - "name": "defaultValue", - "description": "The value that is initially displayed in the displayed keypad", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "minimumValue", - "description": "The lowest value that can be entered", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "maximumValue", - "description": "The highest value that can be entered", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue, maximumValue)" - ], - "overloads": [ - "numberEntered = display.input.number(dialogTitle)", - "numberEntered = display.input.number(dialogTitle, numberFormat)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue)", - "numberEntered = display.input.number(dialogTitle, numberFormat, defaultValue, minimumValue)" - ], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.rel.enable = dmm.ON;relativeoffset = display.input.number(\"Relative offset value\", display.NFORMAT_INTEGER, 0, -1000, 1000);dmm.measure.rel.level = relativeoffset;", - "description": "This example displays a number pad on the screen that defaults to 0 and allows entries from -1000 to 1000. The number that the operator enters is assigned to the relative offset level. If the operator enters a value outside of the range, an error message is displayed.\n--- --\n" - } - ], - "related_commands": [ - "display.input.option()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.option()", - "webhelpfile": "40052.htm", - "signature": "display.input.option(dialogTitle, buttonTitle1, ...)", - "command_return": "BUTTON_OPTIONn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create an option dialog box with customizable buttons on the front-panel display.", - "details": "Buttons are created from top to bottom, left to right. If you have more than five buttons, they are placed into two columns.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "n", - "description": "The number of the button that is selected from the front-panel display; nil if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right", - "enum": "", - "type": "display_BUTTON_OPTIONs | nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "buttonTitle1", - "description": "A string that contains the name of the first button; up to 15 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "buttonTitle2", - "description": "A string that contains the name of the second button; up to 15 characters", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "buttonTitleN", - "description": "A string that contains the names of subsequent buttons, where N is a number from 3 to 10; you can define up to 10 buttons; each button can be up to 15 characters", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "BUTTON_OPTIONn = display.input.option(dialogTitle, buttonTitle1, ...)" - ], - "overloads": [], - "examples": [ - { - "example": "optionID = display.input.option(\"Select an option\", \"Apple\", \"Orange\", \"Papaya\", \"Pineapple\", \"Blueberry\", \"Banana\", \"Grapes\", \"Peach\", \"Apricot\", \"Guava\");print(optionID);", - "description": "This example displays the following dialog box:\n--- --\n--- --If the user selects Peach, the return is display.BUTTON_OPTION8.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.prompt()", - "display.input.string()" - ] - }, - { - "name": "display.input.prompt()", - "webhelpfile": "40053.htm", - "signature": "display.input.prompt(buttonSet, dialogTitle)", - "command_return": "buttonReturn", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a prompt that accepts a user response from the front-panel display.", - "details": "This command waits for a user response to the prompt. You can use the text to ask questions that can be used to configure your test.The prompt is displayed until it has been responded to by the user. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "buttonReturn", - "description": "Indicates which button was pressed", - "enum": "display.BUTTON_OK nil|display.BUTTON_CANCEL nil|display.BUTTON_YES nil|display.BUTTON_NO nil", - "type": "displayinputpromptbuttonReturn", - "range": "" - }, - { - "name": "buttonSet", - "description": "The set of buttons to display", - "enum": "display.BUTTONS_OK nil|display.BUTTONS_CANCEL nil|display.BUTTONS_OKCANCEL nil|display.BUTTONS_YESNO nil|display.BUTTONS_YESNOCANCEL nil", - "type": "displayinputpromptbuttonSet", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 63 characters", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buttonReturn = display.input.prompt(buttonSet, dialogTitle)" - ], - "overloads": [], - "examples": [ - { - "example": "result = display.input.prompt(display.BUTTONS_YESNO, \"Do you want to display the graph screen?\");if result == display.BUTTON_YES then; display.changescreen(display.SCREEN_GRAPH);end;", - "description": "This displays the prompt \"Do you want to display the graph screen?\" on the front-panel display:\n--- --\n--- -- If the operator selects Yes, the graph screen is displayed.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.string()" - ] - }, - { - "name": "display.input.string()", - "webhelpfile": "40054.htm", - "signature": "display.input.string(dialogTitle, textFormat)", - "command_return": "textEntered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create a dialog box that requests text from the user through the front-panel display.", - "details": "This command creates a prompt to the instrument operator to enter a string value.The prompt is displayed until it has been responded to. You can only send one input prompt command at a time.", - "param_info": [ - { - "name": "textEntered", - "description": "The text that is entered from the front-panel display; nil if Cancel is pressed on the keypad", - "enum": "", - "type": "string|nil", - "range": "" - }, - { - "name": "dialogTitle", - "description": "A string that contains the text to be displayed as the title of the dialog box on the front-panel display; up to 32 characters", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "textFormat", - "description": "The format of the entered text", - "enum": "display.SFORMAT_ANY nil|display.SFORMAT_UPPER_LOWER nil|display.SFORMAT_UPPER nil|display.SFORMAT_BUFFER_NAME nil", - "type": "displayinputstringtextFormat", - "range": "" - } - ], - "usage": [ - "textEntered = display.input.string(dialogTitle)", - "textEntered = display.input.string(dialogTitle, textFormat)" - ], - "overloads": [ - "textEntered = display.input.string(dialogTitle)" - ], - "examples": [ - { - "example": "value = display.input.string(\"Enter Test Name\", display.SFORMAT_ANY);print(value);", - "description": "This example displays the prompt \"Enter Test Name\" and a keyboard that the operator can use to enter a\u00a0response.\n--- --\n--- --The return is the response from the operator.\n" - } - ], - "related_commands": [ - "display.input.number()", - "display.input.option()", - "display.input.prompt()" - ] - }, - { - "name": "localnode.prompts4882", - "webhelpfile": "40235.htm", - "signature": "", - "command_return": "prompting", - "type": "Attribute (RW)", - "default_value": "localnode.ENABLE\n", - "tsp_link": "No\n", - "description": "This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.", - "details": "When this attribute is enabled, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If localnode.prompts4882 is enabled, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.When this attribute is disabled, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, disable prompting to avoid problems associated with the command interface input queue filling.", - "param_info": [ - { - "name": "prompting", - "description": "IEEE Std 488.2 prompting mode", - "enum": "localnode.DISABLE nil|localnode.ENABLE nil", - "type": "localnodeprompts4882prompting", - "range": "" - } - ], - "usage": [ - "prompting = localnode.prompts4882", - "localnode.prompts4882 = prompting" - ], - "overloads": [], - "examples": [ - { - "example": "localnode.prompts4882 = localnode.DISABLE;", - "description": "Disables IEEE Std 488.2 common command prompting.\n" - } - ], - "related_commands": [ - "localnode.prompts" - ] - }, - { - "name": "dmm.measure.func", - "webhelpfile": "40942.htm", - "signature": "", - "command_return": "mFunction", - "type": "Attribute (RW)", - "default_value": "dmm.FUNC_DC_VOLTAGE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the active measure function.", - "details": "Set this command to the type of measurement you want to make.Reading this command returns the measure function that is presently active.When you select a function, settings for other commands that are related to the function become active. For example, assume that:If you return to the current function, the math function returns to reciprocal. If you then switch from the current function to the voltage function, the math function returns to percent. All attributes that begin with dmm.measure. are saved with the active measure function unless otherwise indicated in the command description.If a digitize measurement function is active, calling this command returns dmm.FUNC_NONE. The no function setting is automatically made if you select a function with dmm.digitize.func or through the options from the front-panel Digitize Functions tab.", - "param_info": [ - { - "name": "mFunction", - "description": "The type of measurement; see Functions for options", - "enum": "", - "type": "functions", - "range": "" - } - ], - "usage": [ - "mFunction = dmm.measure.func", - "dmm.measure.func = mFunction" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.math.format = dmm.MATH_PERCENT;dmm.measure.math.enable = dmm.ON;dmm.measure.func = dmm.FUNC_RESISTANCE;dmm.measure.math.format = dmm.MATH_RECIPROCAL;dmm.measure.math.enable = dmm.ON;print(dmm.measure.math.format);dmm.measure.func = dmm.FUNC_DC_VOLTAGE;print(dmm.measure.math.format);", - "description": "Sets the instrument to measure voltage and set the math format to percent and enable the math functions.\n--- --Set the instrument to measure resistance and set the math format to reciprocal and enable the math functions.\n--- --Print the math format while the resistance measurement function is selected. The output is:\n--- --dmm.MATH_RECIPROCAL\n--- --Change the function to voltage. Print the math format. The output is:\n--- --dmm.MATH_PERCENT\n" - } - ], - "related_commands": [ - "dmm.digitize.func" - ] - }, - { - "name": "dmm.measure.read()", - "webhelpfile": "40948.htm", - "signature": "dmm.measure.read(bufferName)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes measurements, places them in a reading buffer, and returns the last reading.", - "details": "This command initiates measurements using the present function setting, stores the readings in a reading buffer, and returns the last reading.The dmm.measure.count attribute determines how many measurements are made.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is defined, it defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading = dmm.measure.read()", - "reading = dmm.measure.read(bufferName)" - ], - "overloads": [ - "reading = dmm.measure.read()" - ], - "examples": [ - { - "example": "voltMeasBuffer = buffer.make(10000);dmm.measure.func = dmm.FUNC_DC_VOLTAGE;print(dmm.measure.read(voltMeasBuffer));", - "description": "Create a buffer named voltMeasBuffer. Set the instrument to measure voltage.\n--- --Make a measurement that is stored in the voltMeasBuffer and is also printed.\n" - } - ], - "related_commands": [ - "buffer.make()", - "dmm.digitize.read()", - "dmm.measure.count", - "Reading buffers", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "dmm.digitize.read()", - "webhelpfile": "41093.htm", - "signature": "dmm.digitize.read(bufferName)", - "command_return": "reading", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function makes digitize measurements, places them in a reading buffer, and returns the last reading.", - "details": "You must set the instrument to make digitize measurements before sending this command with the dmm.digitize.func attribute.This command initiates measurements using the present function settings, stores the readings in a reading buffer, and returns the last reading.This command makes the number of digitize measurements that is set by the dmm.digitize.count attribute.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if nothing is specified, the reading is stored in defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading = dmm.digitize.read()", - "reading = dmm.digitize.read(bufferName)" - ], - "overloads": [ - "reading = dmm.digitize.read()" - ], - "examples": [ - { - "example": "voltMeasBuffer = buffer.make(10000);dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;print(dmm.digitize.read(voltMeasBuffer));", - "description": "Create a buffer named voltMeasBuffer. Set the instrument to digitize voltage.\n--- --Make a measurement that is stored in the voltMeasBuffer and is also printed.\n" - } - ], - "related_commands": [ - "buffer.make()", - "dmm.digitize.count", - "dmm.digitize.func", - "dmm.digitize.unit", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "dmm.measure.displaydigits", - "webhelpfile": "41099.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "See Functions and defaults\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the number of digits that are displayed for measurements on the front panel.", - "details": "This command affects how the reading for a measurement is displayed on the front panel of the instrument. It does not affect the number of digits returned in a remote command reading. It also does not affect the accuracy or speed of measurements.The display digits setting is saved with the function setting, so if you use another function, then return to the function for which you set display digits, the display digits setting you set previously is retained.The change in digits occurs the next time a measurement is made.To change the number of digits returned in a remote command reading, use format.asciiprecision.", - "param_info": [ - { - "name": "value", - "description": "3.5 digit resolution", - "enum": "dmm.DIGITS_3_5 nil|dmm.DIGITS_4_5 nil|dmm.DIGITS_5_5 nil|dmm.DIGITS_6_5 nil|dmm.DIGITS_7_5 nil", - "type": "dmmmeasuredisplaydigitsvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions and defaults", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.displaydigits", - "dmm.measure.displaydigits = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_DIGITS)", - "dmm.measure.setattribute(function, ATTR_MEAS_DIGITS, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.displaydigits = dmm.DIGITS_5_5;", - "description": "Set the measurement function to voltage with a front-panel display resolution of 5\u00bd.\n" - } - ], - "related_commands": [ - "dmm.digitize.displaydigits", - "format.asciiprecision" - ] - }, - { - "name": "dmm.measure.autorange", - "webhelpfile": "41117.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the measurement range is set manually or automatically for the selected measure function.", - "details": "This command determines how the range is selected.When this command is set to off, you must set the range. If you do not set the range, the instrument remains at the range that was last selected by autorange.When this command is set to on, the instrument automatically goes to the most sensitive range to perform the measurement.If a range is manually selected through the front panel or a remote command, this command is automatically set to off.Autorange selects the best range in which to measure the signal that is applied to the input terminals of the instrument. When autorange is enabled, the range increases at 120 percent of range. The range decreases occur when the reading is <10\u00a0percent of nominal range. For example, if you are on the 1\u00a0V range and autorange is enabled, the instrument autoranges up to the 10\u00a0V range when the measurement exceeds 1.2\u00a0V. It autoranges down to the 100\u00a0mV range when the measurement falls below 1\u00a0V.", - "param_info": [ - { - "name": "state", - "description": "Set the measurement range manually", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasureautorangestate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.autorange", - "dmm.measure.autorange = state", - "value = dmm.measure.getattribute(function, ATTR_MEAS_RANGE_AUTO)", - "dmm.measure.setattribute(function, ATTR_MEAS_RANGE_AUTO, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.autorange = dmm.ON;", - "description": "Select the measurement function to be DC voltage. Set autorange on.\n" - } - ], - "related_commands": [ - "dmm.measure.range", - "Ranges" - ] - }, - { - "name": "dmm.measure.autozero.enable", - "webhelpfile": "41122.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.", - "details": "To ensure the accuracy of readings, the instrument must periodically get new measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture that is being used for measurements. The DMM7510 uses separate reference and zero measurements for each aperture.By default, the instrument automatically checks these reference measurements whenever a signal measurement is made.The time to make the reference measurements is in addition to the normal measurement time. If timing is critical, you can disable autozero to avoid this time penalty.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.For AC voltage and AC current measurements where the detector bandwidth is set to 3\u00a0Hz or 30\u00a0Hz, autozero is set on and cannot be changed.", - "param_info": [ - { - "name": "state", - "description": "Disable autozero", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasureautozeroenablestate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.autozero.enable", - "dmm.measure.autozero.enable = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_AUTO_ZERO)", - "dmm.measure.setattribute(function, ATTR_MEAS_AUTO_ZERO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.autozero.enable = dmm.OFF;", - "description": "Set autozero off for voltage measurements.\n" - } - ], - "related_commands": [ - "Automatic reference measurements", - "dmm.measure.autozero.once()", - "dmm.measure.nplc" - ] - }, - { - "name": "dmm.measure.autozero.once()", - "webhelpfile": "41124.htm", - "signature": "group.function(value)", - "command_return": "results", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function does something.", - "details": "This command forces a refresh of the reference and zero measurements that are used for the present aperture setting.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.dmm.measure.autozero.once() ", - "param_info": [ - { - "name": "value", - "description": "The parameter meaning something", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "results", - "description": "The return code from the function call", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "results = group.function(value)" - ], - "overloads": [], - "examples": [ - { - "example": "Function;", - "description": "Yes\n" - }, - { - "example": "smu.measure.autozero.once();", - "description": "Do a one\u2011time refresh of the reference and zero measurements.\n" - } - ], - "related_commands": [ - "smu.measure.autozero.enable", - "None" - ] - }, - { - "name": "dmm.measure.autozero.once()", - "webhelpfile": "41130.htm", - "signature": "dmm.digitize.autozero.once()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function causes the instrument to refresh the reference and zero measurements once.", - "details": "This command forces a refresh of the reference and zero measurements that are used for the present aperture setting.When autozero is set to off, the instrument may gradually drift out of specification. To minimize the drift, you can send the once command to make a reference and zero measurement immediately before a test sequence.dmm.measure.autozero.once() ", - "param_info": [ - { - "name": "dmm.digitize.func = dmm.FUNC_DCI_DIGITIZERdmm.digitize.autozero.once()", - "description": "Description or output", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.digitize.autozero.once()" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DCI_DIGITIZER;dmm.digitize.autozero.once();", - "description": "Description or output\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dmm.measure.aperture", - "webhelpfile": "41141.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This function determines the aperture setting for the selected function.", - "details": "The aperture sets the amount of time the ADC takes when making a measurement, which is the integration period for the selected measurement function. The integration period is specified in seconds. In general, a short integration period provides a fast reading rate, while a long integration period provides better accuracy. The selected integration period is a compromise between speed and accuracy.During the integration period, if an external trigger with a count of 1 is sent, the trigger is ignored. If the count is set to more than 1, the first reading is initialized by this trigger. Subsequent readings occur as rapidly as the instrument can make them. If a trigger occurs during the group measurement, the trigger is latched and another group of measurements with the same count will be triggered after the current group completes.You can also set the integration rate by setting the number of power-line cycles (NPLCs). Changing the NPLC value changes the aperture time and changing the aperture time changes the NPLC value.To calculate the aperture based on the NPLC value, use the following formula.where:If you set the NPLCs, the aperture setting changes to reflect that value. If you set the aperture, the NPLC setting is changed.For the AC voltage and AC current functions, if the detector bandwidth setting is set to 3\u00a0Hz or 30\u00a0Hz, the aperture value is fixed and cannot be changed.If line synchronization is enabled, the integration period does not start until the beginning of the next power-line cycle. For example, if a reading is triggered at the positive peak of a power-line cycle, the integration period does not start until that power-line cycle is completed. The integration period starts when the positive-going sine wave crosses 0\u00a0volts.To see the line frequency that is auto-detected by the instrument, use the localnode.linefreq command.", - "param_info": [ - { - "name": "value", - "description": "The integration rate; see Details for ranges", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The measure function; see Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.aperture", - "dmm.measure.aperture = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_APERTURE)", - "dmm.measure.setattribute(function, ATTR_MEAS_APERTURE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.aperture = 0.0035;", - "description": "Set the aperture to 3.5\u00a0ms.\n" - } - ], - "related_commands": [ - "dmm.digitize.aperture", - "dmm.measure.linesync", - "dmm.measure.nplc", - "localnode.linefreq" - ] - }, - { - "name": "dmm.measure.dbreference", - "webhelpfile": "41144.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (1\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the decibel (dB) reference setting for the DMM in volts.", - "details": "This value only applies when the unit setting for the function is set to decibels.", - "param_info": [ - { - "name": "value", - "description": "The decibel reference range", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.dbreference", - "dmm.measure.dbreference = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_DB_REFERENCE)", - "dmm.measure.setattribute(function, ATTR_MEAS_DB_REFERENCE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.unit = dmm.UNIT_DB;dmm.measure.dbreference = 5;", - "description": "Sets the units to decibel and sets the dB reference to 5 for DC volts.\n" - } - ], - "related_commands": [ - "dmm.digitize.dbreference", - "dmm.measure.dbmreference", - "dmm.measure.unit" - ] - }, - { - "name": "dmm.measure.detectorbandwidth", - "webhelpfile": "41147.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "30\u00a0Hz\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the detector bandwidth for AC current and AC voltage measurements.", - "details": "You can set the detector bandwidth to improve measurement accuracy. Select the bandwidth that contains the lowest frequency component of the input signal. For example, if the lowest frequency component of your input signal is 40\u00a0Hz, use a bandwidth setting of 30\u00a0Hz.If the bandwidth is set to 3\u00a0Hz or 30\u00a0Hz, the autozero feature is always enabled and the integration unit is set to Sampling. In addition, the Sampling Time is displayed.", - "param_info": [ - { - "name": "value", - "description": "The bandwidth that is closest to the line frequency", - "enum": "dmm.DETECTBW_3HZ nil|dmm.DETECTBW_30HZ nil|dmm.DETECTBW_300HZ nil", - "type": "dmmmeasuredetectorbandwidthvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.detectorbandwidth", - "dmm.measure.detectorbandwidth = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_DETECTBW)", - "dmm.measure.setattribute(function, ATTR_MEAS_DETECTBW, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_AC_CURRENT;dmm.measure.detectorbandwidth = dmm.DETECTBW_3HZ;", - "description": "Set the measure function to AC current.\n--- --Set the bandwidth to 3\u00a0Hz.\n" - } - ], - "related_commands": [ - "dmm.measure.autozero.enable" - ] - }, - { - "name": "dmm.digitize.displaydigits", - "webhelpfile": "41150.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.DIGITS_4_5\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the number of digits that are displayed on the front panel for the selected function.", - "details": "This command affects how the reading for a measurement is displayed on the front panel of the instrument. It does not affect the number of digits returned in a remote command reading. It also does not affect the accuracy or speed of measurements.The display digits setting is saved with the function setting, so if you use another function, then return to the function for which you set display digits, the display digits setting you set previously is retained.The change in digits occurs the next time a measurement is made.To change the number of digits returned in a remote command reading, use format.asciiprecision.", - "param_info": [ - { - "name": "value", - "description": "6\u00bd display digits", - "enum": "dmm.DIGITS_6_5 nil|dmm.DIGITS_5_5 nil|dmm.DIGITS_4_5 nil|dmm.DIGITS_3_5 nil", - "type": "dmmdigitizedisplaydigitsvalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizedisplaydigitsfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.displaydigits", - "dmm.digitize.displaydigits = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_DIGITS)", - "dmm.measure.setattribute(function, ATTR_DIGI_DIGITS, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.displaydigits = dmm.DIGITS_3_5;", - "description": "Set the instrument to use the digitize current measure function.\n--- --Set the front panel to display 3\u00bd digits.\n" - } - ], - "related_commands": [ - "format.asciiprecision" - ] - }, - { - "name": "dmm.measure.drycircuit", - "webhelpfile": "41155.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the dry circuit feature of the 4-wire resistance measure function.", - "details": "Enabling dry circuit limits the open-circuit voltage to below 20\u00a0mV, which is often required with low-glitch measurements, such as measuring switch and relay contact resistance.When dry circuit is enabled, offset compensation is automatically enabled.", - "param_info": [ - { - "name": "state", - "description": "To disable dry circuit, select dmm.OFF; available for all rangesTo enable dry circuit, select dmm.ON; available for the 1 \u03a9 to 10\u00a0k\u03a9 ranges", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasuredrycircuitstate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.drycircuit", - "dmm.measure.drycircuit = state", - "value = dmm.measure.getattribute(function, ATTR_MEAS_DRY_CIRCUIT)", - "dmm.measure.setattribute(function, ATTR_MEAS_DRY_CIRCUIT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_4W_RESISTANCE;dmm.measure.drycircuit = dmm.ON;", - "description": "Set the measure function to 4-wire resistance and enable dry circuit.\n" - } - ], - "related_commands": [ - "dmm.measure.offsetcompensation.enable", - "dmm.measure.range" - ] - }, - { - "name": "dmm.measure.filter.count", - "webhelpfile": "41157.htm", - "signature": "", - "command_return": "filterCount", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements that are averaged when filtering is enabled.", - "details": "The filter count is the number of readings that are acquired and stored in the filter stack for the averaging calculation. When the filter count is larger, more filtering is done, and the data is less noisy.", - "param_info": [ - { - "name": "filterCount", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "number", - "range": "(1 to 100)" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "filterCount = dmm.measure.filter.count", - "dmm.measure.filter.count = filterCount", - "filterCount = dmm.measure.getattribute(function, ATTR_MEAS_FILTER_COUNT)", - "dmm.measure.setattribute(function, ATTR_MEAS_FILTER_COUNT, filterCount)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.filter.count = 10;dmm.measure.filter.type = dmm.FILTER_MOVING_AVG;dmm.measure.filter.enable = dmm.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "Filtering measurement data", - "dmm.measure.filter.enable", - "dmm.measure.filter.type" - ] - }, - { - "name": "dmm.digitize.filter.count", - "webhelpfile": "41160.htm", - "signature": "", - "command_return": "range", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements that are averaged when filtering is enabled", - "details": "dmm.measure.filter.countThe filter count is the number of readings that are acquired and stored in the filter stack for the averaging calculation. The larger the filter count, the more filtering that is performed.This command is set for the selected function.", - "param_info": [ - { - "name": "range", - "description": "The number of readings required for each filtered measurement (1 to 100)", - "enum": "", - "type": "integer", - "range": "(1 to 100)" - } - ], - "usage": [ - "range = dmm.digitize.filter.count", - "dmm.digitize.filter.count = range" - ], - "overloads": [], - "examples": [ - { - "example": "group.attribute = 2;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.measure.filter.enable", - "webhelpfile": "41161.htm", - "signature": "", - "command_return": "filterState", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the averaging filter for measurements of the selected function.", - "details": "This command enables or disables the averaging filter. When this is enabled, the reading returned by the instrument is an averaged value, taken from multiple measurements. The settings of the filter count and filter type for the selected measure function determines how the reading is averaged.", - "param_info": [ - { - "name": "filterState", - "description": "The filter status", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasurefilterenablefilterState", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "filterState = dmm.measure.filter.enable", - "dmm.measure.filter.enable = filterState", - "filterState = dmm.measure.getattribute(function, ATTR_MEAS_FILTER_ENABLE)", - "dmm.measure.setattribute(function, ATTR_MEAS_FILTER_ENABLE, filterState)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.filter.count = 10;dmm.measure.filter.type = dmm.FILTER_MOVING_AVG;dmm.measure.filter.enable = dmm.ON;", - "description": "Set the measurement function to current.\n--- --Set the averaging filter type to moving average, with a filter count of 10.\n--- --Enable the averaging filter.\n" - } - ], - "related_commands": [ - "Filtering measurement data", - "dmm.measure.filter.count", - "dmm.measure.filter.type" - ] - }, - { - "name": "dmm.digitize.filter.enable", - "webhelpfile": "41163.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the averaging filter for measurements of the selected function.", - "details": "This command enables or disables the averaging filter. When this is enabled, the measurements for the selected measurement function are averaged as set by the filter count and filter type.", - "param_info": [ - { - "name": "value", - "description": "Filter measurements setting", - "enum": "dmm.ON nil|dmm.OFF nil", - "type": "dmmdigitizefilterenablevalue", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.filter.enable", - "dmm.digitize.filter.enable = value" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DCI_DIGITIZER;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.digitize.filter.type", - "webhelpfile": "41164.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.FILTER_MOVING_AVG\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the type of averaging filter that is used for the selected measurement function when the measurement filter is enabled.", - "details": "dmm.digitize.func = dmm.FUNC_DCI_DIGITIZER or dmm.FUNC_DCV_DIGITIZER", - "param_info": [ - { - "name": "value", - "description": "The filter type to use when filtering is enabled; set to one of the following values", - "enum": "dmm.FILTER_REPEAT_AVG nil|dmm.FILTER_MOVING_AVG nil", - "type": "dmmdigitizefiltertypevalue", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.filter.type", - "dmm.digitize.filter.type = value" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.func = \"twowireohms\";dmm.filter.type = dmm.FILTER_MOVING_AVG;dmm.filter.enable = dmm.ON;", - "description": "Set the filter type for 2-wire ohms to moving average and enable filtered measurements.\n" - } - ], - "related_commands": [ - "dmm.digitize.filter.enable" - ] - }, - { - "name": "dmm.measure.filter.type", - "webhelpfile": "41167.htm", - "signature": "", - "command_return": "type", - "type": "Attribute (RW)", - "default_value": "dmm.FILTER_REPEAT_AVG\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the type of averaging filter that is used for the selected measure function when the measurement filter is enabled.", - "details": "When the repeating average filter is selected, a set of measurements are made. These measurements are stored in a measurement stack and averaged together to produce the averaged sample. Once the averaged sample is produced, the stack is flushed, and the next set of data is used to produce the next averaged sample. This type of filter is the slowest, since the stack must be completely filled before an averaged sample can be produced.When the moving average filter is selected, the measurements are added to the stack continuously on a first-in, first-out basis. As each measurement is made, the oldest measurement is removed from the stack. A new averaged sample is produced using the new measurement and the data that is now in the stack.The repeating average filter produces slower results but produces more stable results than the moving average filter. For either method, the greater the number of measurements that are averaged, the slower the averaged sample rate, but the lower the noise error. Trade-offs between speed and noise are normally required to tailor the instrumentation to your measurement application.", - "param_info": [ - { - "name": "type", - "description": "The filter type setting", - "enum": "dmm.FILTER_REPEAT_AVG nil|dmm.FILTER_MOVING_AVG nil", - "type": "dmmmeasurefiltertypetype", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "type = dmm.measure.filter.type", - "dmm.measure.filter.type = type", - "type = dmm.measure.getattribute(function, ATTR_MEAS_FILTER_TYPE)", - "dmm.measure.setattribute(function, ATTR_MEAS_FILTER_TYPE, type)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.filter.type = dmm.FILTER_MOVING_AVG;dmm.measure.filter.enable = dmm.ON;", - "description": "Set the measurement function to DC current. Set the filter type to moving average and enable filtered measurements.\n" - } - ], - "related_commands": [ - "dmm.measure.filter.enable" - ] - }, - { - "name": "dmm.digitize.filter.window", - "webhelpfile": "41169.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0.1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the window for the averaging filter that is used for measurements for the selected function when the measurement filter is enabled.", - "details": "", - "param_info": [ - { - "name": "value", - "description": "The filter window setting; the range is between 0 and 10 to indicate percent of range", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.filter.window", - "dmm.digitize.filter.window = value" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DCI_DIGITIZER;dmm.digitize.filter.window = 5;", - "description": "\u00a0\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.measure.filter.window", - "webhelpfile": "41173.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0 (no filter)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the window for the averaging filter that is used for measurements for the selected function.", - "details": "This command selects the window size for the averaging filter.The noise window allows a faster response time to large signal step changes. A reading that falls outside the plus or minus noise window fills the filter stack immediately.If the noise does not exceed the selected percentage of range, the reading is based on an average of reading conversions \u2014 the normal averaging filter. If the noise does exceed the selected percentage, the reading is a single reading conversion, and new averaging starts from this point.", - "param_info": [ - { - "name": "value", - "description": "The filter window setting; the range is between 0 and 10 to indicate percent of range", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.filter.window", - "dmm.measure.filter.window = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_FILTER_WINDOW)", - "dmm.measure.setattribute(function, ATTR_MEAS_FILTER_WINDOW, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_RESISTANCE;dmm.measure.filter.type = dmm.FILTER_MOVING_AVG;dmm.measure.filter.window = 0.25;dmm.measure.filter.enable = dmm.ON;", - "description": "Set the measure function to 2-wire ohms.\n--- --Set the filter type to moving average.\n--- --Set the filter window to 0.25 and enable filtered measurements.\n" - } - ], - "related_commands": [ - "dmm.measure.filter.enable", - "dmm.measure.filter.type" - ] - }, - { - "name": "dmm.measure.fourrtd", - "webhelpfile": "41175.htm", - "signature": "", - "command_return": "RTDType", - "type": "Attribute (RW)", - "default_value": "dmm.RTD_PT100\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the type of 4-wire RTD that is being used", - "details": "The transducer type must be set to temperature and the transducer must be set to 4-wire RTD before you can set the RTD type.", - "param_info": [ - { - "name": "RTDType", - "description": "The type of 4-wire RTD", - "enum": "dmm.RTD_PT100 nil|dmm.RTD_PT385 nil|dmm.RTD_PT3916 nil|dmm.RTD_D100 nil|dmm.RTD_F100 nil|dmm.RTD_USER nil", - "type": "dmmmeasurefourrtdRTDType", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "RTDType = dmm.measure.fourrtd", - "dmm.measure.fourrtd = RTDType", - "RTDType= dmm.measure.getattribute(function, ATTR_MEAS_FOUR_RTD)", - "dmm.measure.setattribute(function, ATTR_MEAS_FOUR_RTD, RTDType)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_FOURRTD;dmm.measure.fourrtd = dmm.RTD_PT3916;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to 4-wire RTD.\n--- --Set the RTD type to PT3916.\n" - } - ], - "related_commands": [ - "dmm.measure.rtdalpha", - "dmm.measure.rtdbeta", - "dmm.measure.rtddelta", - "dmm.measure.rtdzero", - "dmm.measure.transducer", - "Temperature measurements" - ] - }, - { - "name": "dmm.measure.threertd", - "webhelpfile": "41176.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.RTD_PT100\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the type of three-wire RTD that is being used.", - "details": "The transducer type must be set to temperature and the transducer must be set to 3-wire RTD before you can set the RTD type.", - "param_info": [ - { - "name": "value", - "description": "The type for 3-wire RTD", - "enum": "dmm.RTD_PT100 3|dmm.RTD_PT385 nil|dmm.RTD_PT3916 nil|dmm.RTD_D100 nil|dmm.RTD_F100 nil|dmm.RTD_USER nil", - "type": "dmmmeasurethreertdvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.threertd", - "dmm.measure.threertd = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_THREE_RTD)", - "dmm.measure.setattribute(function, ATTR_MEAS_THREE_RTD, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THREERTD;dmm.measure.threertd = dmm.RTD_D100;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to 3-wire RTD.\n--- --Set the RTD type to D100.\n" - } - ], - "related_commands": [ - "dmm.measure.rtdalpha", - "dmm.measure.rtdbeta", - "dmm.measure.rtddelta", - "dmm.measure.rtdzero", - "dmm.measure.transducer", - "Temperature measurements" - ] - }, - { - "name": "dmm.measure.transducer", - "webhelpfile": "41181.htm", - "signature": "", - "command_return": "type", - "type": "Attribute (RW)", - "default_value": "dmm.TRANS_THERMOCOUPLE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the transducer type for the temperature measurement function.", - "details": "The transducer type determines the type of temperature measurement that is made. Each transducer type has related settings that must also be set. For example, thermocouple measurements are only made if the type is set is set to thermocouple. You also need to set the thermocouple type when setting up a thermocouple. For the RTD transducer types, you also set the RTD type.", - "param_info": [ - { - "name": "type", - "description": "The transducer type", - "enum": "dmm.TRANS_THERMOCOUPLE nil|dmm.TRANS_THERMISTOR nil|dmm.TRANS_THREERTD nil|dmm.TRANS_FOURRTD nil", - "type": "dmmmeasuretransducertype", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "type = dmm.measure.transducer", - "dmm.measure.transducer = type", - "type = dmm.measure.getattribute(function, ATTR_MEAS_TRANSDUCER)", - "dmm.measure.setattribute(function, ATTR_MEAS_TRANSDUCER, type)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THREERTD;dmm.measure.threertd = dmm.RTD_D100;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to 3-wire RTD.\n--- --Set the RTD type to D100.\n" - } - ], - "related_commands": [ - "dmm.measure.fourrtd", - "dmm.measure.thermistor", - "dmm.measure.thermocouple", - "dmm.measure.threertd", - "Temperature measurements" - ] - }, - { - "name": "dmm.measure.rtdalpha", - "webhelpfile": "41182.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0.00385055\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the alpha value of a user-defined RTD.", - "details": "This attribute is only valid when:", - "param_info": [ - { - "name": "value", - "description": "The RTD alpha value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.rtdalpha", - "dmm.measure.rtdalpha = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_RTD_ALPHA)", - "dmm.measure.setattribute(function, ATTR_MEAS_RTD_ALPHA, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THREERTD;dmm.measure.threertd = dmm.RTD_USER;dmm.measure.rtdalpha = 0.00385;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to 3-wire RTD.\n--- --Set the RTD type to User.\n--- --Set the alpha RTD value to 0.00385.\n" - } - ], - "related_commands": [ - "dmm.measure.fourrtd", - "dmm.measure.threertd", - "dmm.measure.transducer" - ] - }, - { - "name": "dmm.measure.rtdbeta", - "webhelpfile": "41186.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0.10863\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the beta value of a user-defined RTD.", - "details": "This attribute is only valid when:", - "param_info": [ - { - "name": "value", - "description": "The RTD beta value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.rtdbeta", - "dmm.measure.rtdbeta = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_RTD_BETA)", - "dmm.measure.setattribute(function, ATTR_MEAS_RTD_BETA, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THREERTD;dmm.measure.threertd = dmm.RTD_USER;dmm.measure.rtdalpha = 0.00385;dmm.measure.rtdbeta = 0.10863;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to 3-wire RTD.\n--- --Set the RTD type to User.\n--- --Set the alpha RTD value to 0.00385.\n--- --Set the beta RTD value to 0.10863.\n" - } - ], - "related_commands": [ - "dmm.measure.fourrtd", - "dmm.measure.threertd", - "dmm.measure.transducer" - ] - }, - { - "name": "dmm.measure.rtddelta", - "webhelpfile": "41188.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1.4999\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the delta value of a user-defined RTD.", - "details": "This attribute is only valid when:", - "param_info": [ - { - "name": "value", - "description": "The RTD delta value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.rtddelta", - "dmm.measure.rtddelta = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_RTD_DELTA)", - "dmm.measure.setattribute(function, ATTR_MEAS_RTD_DELTA, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THREERTD;dmm.measure.threertd = dmm.RTD_USER;dmm.measure.rtddelta = 1.49990;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to 3-wire RTD.\n--- --Set the RTD type to User.\n--- --Set the delta RTD value to 1.49990.\n" - } - ], - "related_commands": [ - "dmm.measure.fourrtd", - "dmm.measure.threertd", - "dmm.measure.transducer" - ] - }, - { - "name": "dmm.measure.rtdzero", - "webhelpfile": "41191.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "100\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the zero value of a user-defined RTD.", - "details": "This attribute is only valid when:", - "param_info": [ - { - "name": "value", - "description": "The zero value of the RTD", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.rtdzero", - "dmm.measure.rtdzero = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_RTD_ZERO)", - "dmm.measure.setattribute(function, ATTR_MEAS_RTD_ZERO, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THREERTD;dmm.measure.threertd = dmm.RTD_USER;dmm.measure.rtdalpha = 0.00385;dmm.measure.rtdzero = 120;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to 3-wire RTD.\n--- --Set the RTD type to User.\n--- --Set the alpha RTD value to 0.00385.\n--- --Set the zero RTD value to 120.\n" - } - ], - "related_commands": [ - "dmm.measure.fourrtd", - "dmm.measure.threertd", - "dmm.measure.transducer" - ] - }, - { - "name": "dmm.measure.thermistor", - "webhelpfile": "41192.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.THERM_5000\n", - "tsp_link": "Yes\n", - "description": "This attribute describes the type of thermistor.", - "details": "This command is only applicable when the transducer type is set to thermistor.", - "param_info": [ - { - "name": "value", - "description": "The thermistor type in ohms", - "enum": "dmm.THERM_2252 nil|dmm.THERM_5000 nil|dmm.THERM_10000 nil", - "type": "dmmmeasurethermistorvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.thermistor", - "dmm.measure.thermistor = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_THERMISTOR)", - "dmm.measure.setattribute(function, ATTR_MEAS_THERMISTOR, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THERMISTOR;dmm.measure.thermistor = dmm.THERM_2252;", - "description": "Set measurement function to temperature.\n--- --Set the transducer type to thermistor.\n--- --Set the thermistor type to 2252.\n" - } - ], - "related_commands": [ - "dmm.measure.transducer", - "Temperature measurements" - ] - }, - { - "name": "dmm.measure.thermocouple", - "webhelpfile": "41197.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.THERMOCOUPLE_K\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the thermocouple type.", - "details": "This command is only applicable when the transducer type is set to thermocouple.", - "param_info": [ - { - "name": "value", - "description": "The thermocouple type", - "enum": "dmm.THERMOCOUPLE_B nil|dmm.THERMOCOUPLE_E nil|dmm.THERMOCOUPLE_J nil|dmm.THERMOCOUPLE_K nil|dmm.THERMOCOUPLE_N nil|dmm.THERMOCOUPLE_R nil|dmm.THERMOCOUPLE_S nil|dmm.THERMOCOUPLE_T nil", - "type": "dmmmeasurethermocouplevalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.thermocouple", - "dmm.measure.thermocouple = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_THERMOCOUPLE)", - "dmm.measure.setattribute(function, ATTR_MEAS_THERMOCOUPLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THERMOCOUPLE;dmm.measure.thermocouple = dmm.THERMOCOUPLE_J;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to thermocouple.\n--- --Set the thermocouple type to J.\n" - } - ], - "related_commands": [ - "dmm.measure.transducer", - "dmm.measure.simreftemperature", - "Temperature measurements" - ] - }, - { - "name": "dmm.measure.refjunction", - "webhelpfile": "41198.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.REFJUNCTION_INTERNAL\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the type of the thermocouple reference junction.", - "details": "", - "param_info": [ - { - "name": "state", - "description": "The reference junction type", - "enum": "dmm.REFJUNCTION_SIMULATED nil|dmm.REFJUNCTION_INTERNAL nil|dmm.REFJUNCTION_EXTERNAL nil", - "type": "dmmmeasurerefjunctionstate", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.refjunction", - "dmm.measure.refjunction = state" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = \"temperature\";dmm.transducer = dmm.TEMP_THERMOCOUPLE;dmm.refjunction = dmm.REF_JUNCTION_SIMULATED;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.measure.inputdivider", - "webhelpfile": "41202.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the 10\u00a0MW input divider.", - "details": "", - "param_info": [ - { - "name": "state", - "description": "Disable input divider", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasureinputdividerstate", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.inputdivider", - "dmm.measure.inputdivider = state" - ], - "overloads": [], - "examples": [ - { - "example": "group.attribute = 2;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.digitize.inputdivider", - "webhelpfile": "41205.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the 10\u00a0MW input divider.", - "details": "Is automatically ON when range is 100 V or 1000 VOnly available for DC volts.dmm.digitize.func = dmm.FUNC_DCV_DIGITIZERThe default is dmm.OFF for all ranges except 100 V and 1000 \u00a0V. For the 100 V and 1000 V ranges, this is automatically turned ON. *** can it be turned off for those two ranges? ***see dmm.measure.inputdivider", - "param_info": [ - { - "name": "value", - "description": "Disable input divider", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmdigitizeinputdividervalue", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.inputdivider", - "dmm.digitize.inputdivider = value" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DCV_DIGITIZER;dmm.digitize.inputdivider = dmm.ON;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.measure.limit[Y].autoclear", - "webhelpfile": "41208.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the test result for limit Y should be cleared automatically or not.", - "details": "When auto clear is set to on, limit conditions are cleared automatically after each measurement. If you are making a series of measurements, the instrument shows the limit test result of the last measurement for the pass or fail indication for the limit.If you want to know if any of a series of measurements failed the limit, set the auto clear setting to off. When this is set to off, a failed indication is not cleared automatically. It remains set until it is cleared with the clear command.The auto clear setting affects both the high and low limits.See dmm.measure.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "value", - "description": "The auto clear setting", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasurelimitautoclearvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.limit[Y].autoclear", - "dmm.measure.limit[Y].autoclear = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y)", - "dmm.measure.setattribute(function, ATTR_MEAS_LIMIT_AUTO_CLEAR_Y, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.FUNC_DC_VOLTAGE;", - "description": "dmm.FUNC_RESISTANCE\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].autoclear", - "dmm.measure.limit[Y].enable" - ] - }, - { - "name": "dmm.digitize.limit[Y].autoclear", - "webhelpfile": "41210.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates if the test result for limit Y should be cleared automatically or not.", - "details": "When auto clear is set to on, limit conditions are cleared automatically after each measurement. If you are making a series of measurements, the instrument shows the limit test result of the last measurement for the pass or fail indication for the limit.If you want to know if any of a series of measurements failed the limit, set the auto clear setting to off. When this is set to off, a failed indication is not cleared automatically. It remains set until it is cleared with the clear command.The auto clear setting affects both the high and low limits.", - "param_info": [ - { - "name": "state", - "description": "The auto clear setting", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmdigitizelimitautoclearstate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizelimitautoclearfunction", - "range": "" - } - ], - "usage": [ - "state = dmm.digitize.limit[Y].autoclear", - "dmm.digitize.limit[Y].autoclear = state", - "state = dmm.measure.getattribute(function, ATTR_DIGI_LIMIT_AUTO_CLEAR_Y)", - "dmm.measure.setattribute(function, ATTR_DIGI_LIMIT_AUTO_CLEAR_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.limit[1].autoclear = dmm.OFF;", - "description": "Turns off autoclear for limit 1 when measuring digitize voltage.\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].enable" - ] - }, - { - "name": "dmm.measure.limit[Y].clear()", - "webhelpfile": "41212.htm", - "signature": "dmm.measure.limit[Y].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the results of the limit test defined by Y.", - "details": "Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared.To avoid the need to manually clear the test results for a limit, turn the auto clear option on.See dmm.measure.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.measure.limit[Y].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.FUNC_DC_VOLTAGE;", - "description": "dmm.FUNC_RESISTANCE\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].clear()", - "dmm.measure.limit[Y].autoclear" - ] - }, - { - "name": "dmm.digitize.limit[Y].clear()", - "webhelpfile": "41213.htm", - "signature": "dmm.digitize.limit[Y].clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This attribute clears the results of the limit test defined by Y.", - "details": "Use this command to clear the test results of limit Y when the limit auto clear option is turned off. Both the high and low test results are cleared.To avoid the need to manually clear the test results for a limit, turn the auto clear option on.", - "param_info": [ - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.digitize.limit[Y].clear()" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.limit[1].clear();", - "description": "Set the digitize function to voltage.\n--- --Clear the results of limit test 1.\n" - } - ], - "related_commands": [ - "Digitize functions", - "dmm.digitize.limit[Y].autoclear", - "dmm.digitize.func" - ] - }, - { - "name": "dmm.measure.limit[Y].fail", - "webhelpfile": "41214.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute queries the results of a limit test.", - "details": "This command queries the result of a limit test for the selected measurement function.The response message indicates if the limit test passed or how it failed (on the high or low limit).If autoclear is set to off, reading the results of a limit test does not clear the fail indication of the test. To clear a failure, send the clear command. To automatically clear the results, set auto clear on.If auto clear is set to on and you are making a series of measurements, the last measurement limit determines the fail indication for the limit. If auto clear is turned off, the results return a test fail if any of one of the readings failed.To use this attribute, you must set the limit state to on.If the readings are stored in a reading buffer, you can use the bufferVar.statuses command to see the results.See dmm.measure.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "value", - "description": "The results of the limit test for limit Y", - "enum": "dmm.FAIL_NONE nil|dmm.FAIL_HIGH nil|dmm.FAIL_LOW nil|dmm.FAIL_BOTH nil", - "type": "dmmmeasurelimitfailvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.limit[Y].fail" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.FUNC_DC_VOLTAGE;", - "description": "dmm.FUNC_RESISTANCE\n" - } - ], - "related_commands": [ - "bufferVar.statuses", - "dmm.digitize.limit[Y].fail", - "dmm.measure.limit[Y].enable" - ] - }, - { - "name": "dmm.digitize.limit[Y].low.value", - "webhelpfile": "41215.htm", - "signature": "", - "command_return": "lowLimit", - "type": "Attribute (RW)", - "default_value": "-1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the lower limit for limit tests.", - "details": "This command sets the lower limit for the limit Y test for the selected digitize function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.This example enables limits 1 and 2 for digitize voltage measurements. Limit 1 is checking for readings to be between 3\u00a0V and 5\u00a0V, while limit\u00a02 is checking for the readings to be between 1\u00a0V and 7\u00a0V. The auto clear feature is disabled, so if any reading is outside these limits, the corresponding fail is 1. Therefore, if any one of the fails is 1, analyze the reading buffer data to find out which reading failed the limits.", - "param_info": [ - { - "name": "lowLimit", - "description": "The low limit value of limit Y (-1E+12 to 1E+12)", - "enum": "", - "type": "number", - "range": "(-1E+12 to 1E+12)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizelimitlowvaluefunction", - "range": "" - } - ], - "usage": [ - "lowLimit = dmm.digitize.limit[Y].low.value", - "dmm.digitize.limit[Y].low.value = lowLimit", - "lowLimit = dmm.measure.getattribute(function, ATTR_DIGI_LIMIT_LOW_Y)", - "dmm.measure.setattribute(function, ATTR_DIGI_LIMIT_LOW_Y, lowLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();-- Set the instrument to measure digitized voltage ;dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;-- Set the range to 10 V;dmm.digitize.range = 10;-- Disable auto clearing for limit 1;dmm.digitize.limit[1].autoclear = dmm.OFF;-- Set high limit on 1 to fail if reading exceeds 5 V;dmm.digitize.limit[1].high.value = 5;-- Set low limit on 1 to fail if reading is less than 3 V;dmm.digitize.limit[1].low.value = 3;-- Enable limit 1 checking for digitized voltage measurements;dmm.digitize.limit[1].enable = dmm.ON;-- Disable auto clearing for limit 2;dmm.digitize.limit[2].autoclear = dmm.OFF;-- Set high limit on 2 to fail if reading exceeds 7 V;dmm.digitize.limit[2].high.value = 7;-- Set low limit on 2 to fail if reading is less than 1 V;dmm.digitize.limit[2].low.value = 1;-- Set the beeper to sound if the reading exceeds the limits for limit 2;dmm.digitize.limit[2].audible = dmm.AUDIBLE_FAIL ;-- Enable limit 2 checking for digitized voltage measurements;dmm.digitize.limit[2].enable = dmm.ON;-- Set the digitize count to 50;dmm.digitize.count = 50;-- Create a reading buffer that can store 100 readings;LimitBuffer = buffer.make(100);-- Make 50 readings and store them in LimitBuffer;dmm.digitize.read(LimitBuffer);-- Check if any of the 50 readings were outside of the limits;print(\"limit 1 results = \" .. dmm.digitize.limit[1].fail);print(\"limit 2 results = \" .. dmm.digitize.limit[2].fail);-- Clear limit 1 conditions;dmm.digitize.limit[1].clear();-- Clear limit 2 conditions;dmm.digitize.limit[2].clear();", - "description": "Example output that shows all readings are within limit values (all readings between 3 V and 5 V):\n--- --limit 1 results = dmm.FAIL_NONE\n--- --limit 2 results = dmm.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 high values (a 6\u00a0V reading would cause this condition or a reading greater than 5 V but less than 7 V):\n--- --limit 1 results = dmm.FAIL_HIGH\n--- --limit 2 results = dmm.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 and 2 low values (a 0.5 V reading would cause this condition or a reading less than 1\u00a0V):\n--- --limit 1 results = dmm.FAIL_LOW\n--- --limit 2 results = dmm.FAIL_LOW\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].autoclear", - "dmm.digitize.limit[Y].clear()", - "dmm.digitize.limit[Y].enable", - "dmm.digitize.limit[Y].fail", - "dmm.digitize.limit[Y].high.value" - ] - }, - { - "name": "dmm.digitize.limit[Y].fail", - "webhelpfile": "41221.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute queries the results of a limit test.", - "details": "This command queries the result of a limit test for the selected digitize function.The response message indicates if the limit test passed or how it failed (on the high or low limit).If autoclear is set to off, reading the results of a limit test does not clear the fail indication of the test. To clear a failure, send the clear command. To automatically clear the results, set auto clear on.If auto clear is set to on and you are making a series of measurements, the last measurement limit determines the fail indication for the limit. If auto clear is turned off, the results return a test fail if any of one of the readings failed.To use this attribute, you must set the limit state to on.If the readings are stored in a reading buffer, you can use the bufferVar.statuses command to see the results.See dmm.digitize.limit[Y].low.value for examples of how to use this command.", - "param_info": [ - { - "name": "value", - "description": "The results of the limit test for limit Y", - "enum": "dmm.FAIL_NONE nil|dmm.FAIL_HIGH nil|dmm.FAIL_LOW nil|dmm.FAIL_BOTH nil", - "type": "dmmdigitizelimitfailvalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizelimitfailfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.limit[Y].fail", - "value = dmm.measure.getattribute(function, ATTR_DIGI_LIMIT_FAIL_Y)" - ], - "overloads": [], - "examples": [ - { - "example": "value;", - "description": "The results of the limit test for limit Y:\n--- --dmm.FAIL_NONE: Test passed; measurement under or equal to the high limitdmm.FAIL_HIGH: Test failed; measurement exceeded high limitdmm.FAIL_LOW: Test failed; measurement exceeded low limitdmm.FAIL_BOTH: Test failed; measurement exceeded both " - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].enable" - ] - }, - { - "name": "dmm.digitize.limit[Y].enable", - "webhelpfile": "41225.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables a limit test on the measurement from the selected digitize function.", - "details": "This command enables or disables a limit test for the selected digitize function. When this attribute is enabled, the limit Y testing occurs on each measurement made by the instrument. Limit Y testing compares the measurements to the high and low limit values. If a measurement falls outside these limits, the test fails.See dmm.digitize.limit[Y].low.value for examples of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "Limit Y testing", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmdigitizelimitenablestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizelimitenablefunction", - "range": "" - } - ], - "usage": [ - "state = dmm.digitize.limit[Y].enable", - "dmm.digitize.limit[Y].enable = state", - "state = dmm.measure.getattribute(function, ATTR_DIGI_LIMIT_ENABLE_Y)", - "dmm.measure.setattribute(function, ATTR_DIGI_LIMIT_ENABLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "state;", - "description": "Limit Y testing:\n--- --Disable: dmm.OFFEnable: " - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].low.value", - "dmm.digitize.limit[Y].high.value" - ] - }, - { - "name": "dmm.digitize.limit[Y].high.value", - "webhelpfile": "41227.htm", - "signature": "", - "command_return": "highLimit", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the upper limit for a limit test.", - "details": "This command sets the high limit for the limit Y test for the selected digitize function. When limit Y testing is enabled, the instrument generates a fail indication when the measurement value is more than this value.See dmm.digitize.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "highLimit", - "description": "The value of the upper limit (-1e+12 to 1e+12)", - "enum": "", - "type": "number", - "range": "(-1e+12 to 1e+12)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizelimithighvaluefunction", - "range": "" - } - ], - "usage": [ - "highLimit = dmm.digitize.limit[Y].high.value", - "dmm.digitize.limit[Y].high.value = highLimit", - "highLimit = dmm.measure.getattribute(function, ATTR_DIGI_LIMIT_HIGH_Y)", - "dmm.measure.setattribute(function, ATTR_DIGI_LIMIT_HIGH_Y, highLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "highLimit;", - "description": "The value of the upper limit (-1e+12 to 1e+12)\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].enable", - "dmm.digitize.limit[Y].low.value" - ] - }, - { - "name": "dmm.measure.limit[Y].low.value", - "webhelpfile": "41229.htm", - "signature": "", - "command_return": "lowLimit", - "type": "Attribute (RW)", - "default_value": "-1 for most functions; see Details \n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the lower limit for limit tests.", - "details": "This command sets the lower limit for the limit Y test for the selected measure function. When limit Y testing is enabled, this causes a fail indication to occur when the measurement value is less than this value.Default is 0.3 for limit 1 when the diode function is selected. The default for limit 2 for the diode function is \u20131.This example enables limits 1 and 2 for voltage measurements. Limit 1 is checking for readings to be between 3 and 5 V, while limit\u00a02 is checking for the readings to be between 1 and 7 V. The auto clear feature is disabled, so if any reading is outside these limits, the corresponding fail is 1. Therefore, if any one of the fails is 1, analyze the reading buffer data to determine which reading failed the limits.", - "param_info": [ - { - "name": "lowLimit", - "description": "The low limit value of limit Y (-1E+12 to 1E+12)", - "enum": "", - "type": "number", - "range": "(-1E+12 to 1E+12)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "lowLimit = dmm.measure.limit[Y].low.value", - "dmm.measure.limit[Y].low.value = lowLimit", - "lowLimit = dmm.measure.getattribute(function, ATTR_MEAS_LIMIT_LOW_Y)", - "dmm.measure.setattribute(function, ATTR_MEAS_LIMIT_LOW_Y, lowLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();-- Set the instrument to measure voltage ;dmm.measure.func = dmm.FUNC_DC_VOLTAGE;-- Set the range to 10 V;dmm.measure.range = 10;-- Set the nplc to 0.1;dmm.measure.nplc = 0.1;-- Disable auto clearing for limit 1;dmm.measure.limit[1].autoclear = dmm.OFF;-- Set high limit on 1 to fail if reading exceeds 5 V;dmm.measure.limit[1].high.value = 5;-- Set low limit on 1 to fail if reading is less than 3 V;dmm.measure.limit[1].low.value = 3;--- Set the beeper to sound if the reading exceeds the limits for limit 1;dmm.measure.limit[1].audible = dmm.AUDIBLE_FAIL;-- Enable limit 1 checking for voltage measurements;dmm.measure.limit[1].enable = dmm.ON;-- Disable auto clearing for limit 2;dmm.measure.limit[2].autoclear = dmm.OFF;-- Set high limit on 2 to fail if reading exceeds 7 V;dmm.measure.limit[2].high.value = 7;-- Set low limit on 2 to fail if reading is less than 1 V;dmm.measure.limit[2].low.value = 1;-- Enable limit 2 checking for voltage measurements;dmm.measure.limit[2].enable = dmm.ON;-- Set the measure count to 50;dmm.measure.count = 50;-- Create a reading buffer that can store 100 readings;LimitBuffer = buffer.make(100);-- Make 50 readings and store them in LimitBuffer;dmm.measure.read(LimitBuffer);-- Check if any of the 50 readings were outside of the limits;print(\"limit 1 results = \" .. dmm.measure.limit[1].fail);print(\"limit 2 results = \" .. dmm.measure.limit[2].fail);-- Clear limit 1 conditions;dmm.measure.limit[1].clear();-- Clear limit 2 conditions;dmm.measure.limit[2].clear();", - "description": "Example output that shows all readings are within limit values (all readings between 3 V and 5 V):\n--- --limit 1 results = dmm.FAIL_NONE\n--- --limit 2 results = dmm.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 high values (a 6\u00a0V reading would cause this condition or a reading greater than 5 V but less than 7 V):\n--- --limit 1 results = dmm.FAIL_HIGH\n--- --limit 2 results = dmm.FAIL_NONE\n--- --\u00a0\n--- --Example output showing at least one reading failed limit 1 and 2 low values (a 0.5 V reading would cause this condition or a reading less than 1\u00a0V):\n--- --limit 1 results = dmm.FAIL_LOW\n--- --limit 2 results = dmm.FAIL_LOW\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].low.value", - "dmm.measure.limit[Y].autoclear", - "dmm.measure.limit[Y].clear()", - "dmm.measure.limit[Y].enable", - "dmm.measure.limit[Y].fail", - "dmm.measure.limit[Y].high.value" - ] - }, - { - "name": "dmm.measure.limit[Y].high.value", - "webhelpfile": "41230.htm", - "signature": "", - "command_return": "highLimit", - "type": "Attribute (RW)", - "default_value": "1 for most functions; see Details \n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the upper limit for a limit test.", - "details": "This command sets the high limit for the limit Y test for the selected measurement function. When limit Y testing is enabled, the instrument generates a fail indication when the measurement value is more than this value.Default is 0.8 for limit 1 when the diode function is selected; 10 when the continuity function is selected. The default for limit 2 for the diode and continuity functions is 1.See dmm.measure.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "highLimit", - "description": "The value of the upper limit (-1e+12 to 1e+12)", - "enum": "", - "type": "number", - "range": "(-1e+12 to 1e+12)" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "highLimit = dmm.measure.limit[Y].high.value", - "dmm.measure.limit[Y].high.value = highLimit", - "highLimit = dmm.measure.getattribute(function, ATTR_MEAS_LIMIT_HIGH_Y)", - "dmm.measure.setattribute(function, ATTR_MEAS_LIMIT_HIGH_Y, highLimit)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.FUNC_DC_VOLTAGE;", - "description": "dmm.FUNC_RESISTANCE\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].high.value", - "dmm.measure.limit[Y].enable", - "dmm.measure.limit[Y].low.value" - ] - }, - { - "name": "dmm.measure.limit[Y].enable", - "webhelpfile": "41231.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables a limit test on the measurement from the selected measure function.", - "details": "This command enables or disables a limit test for the selected measurement function. When this attribute is enabled, the limit Y testing occurs on each measurement made by the instrument. Limit Y testing compares the measurements to the high-limit and low-limit values. If a measurement falls outside these limits, the test fails.See dmm.measure.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "Limit Y testing", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasurelimitenablestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.limit[Y].enable", - "dmm.measure.limit[Y].enable = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y)", - "dmm.measure.setattribute(function, ATTR_MEAS_LIMIT_ENABLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.FUNC_DC_VOLTAGE;", - "description": "dmm.FUNC_RESISTANCE\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].enable", - "dmm.measure.limit[Y].autoclear", - "dmm.measure.limit[Y].clear()", - "dmm.measure.limit[Y].fail", - "dmm.measure.limit[Y].high.value", - "dmm.measure.limit[Y].low.value" - ] - }, - { - "name": "dmm.measure.linesync", - "webhelpfile": "41233.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if line synchronization is used during the measurement.", - "details": "When line synchronization is enabled, measurements are initiated at the first positive-going zero crossing of the power line cycle after the trigger.", - "param_info": [ - { - "name": "state", - "description": "Disable line sync", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasurelinesyncstate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.linesync", - "dmm.measure.linesync = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_LINE_SYNC)", - "dmm.measure.setattribute(function, ATTR_MEAS_LINE_SYNC, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.linesync = dmm.ON;", - "description": "Set line synchronization on for DC current measurements.\n" - } - ], - "related_commands": [ - "Line cycle synchronization" - ] - }, - { - "name": "dmm.measure.math.enable", - "webhelpfile": "41235.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables math operations on measurements for the selected measurement function.", - "details": "When this command is set to on, the math operation specified by the math format command is performed before completing a measurement.", - "param_info": [ - { - "name": "value", - "description": "The math enable setting", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasuremathenablevalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.math.enable", - "dmm.measure.math.enable = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_MATH_ENABLE)", - "dmm.measure.setattribute(function, ATTR_MEAS_MATH_ENABLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.math.format = dmm.MATH_PERCENT;dmm.measure.count = 1;dmm.measure.math.percent = dmm.measure.read();dmm.measure.math.enable = dmm.ON;dmm.measure.count = 5;MathBuffer = buffer.make(100);dmm.measure.read(MathBuffer);printbuffer(1, MathBuffer.n, MathBuffer.formattedreadings);dmm.measure.count = 1;for x = 1, 3 do ; print(dmm.measure.read(MathBuffer));end;", - "description": "Configure the instrument for DC volts and reset the DC volts function to the default settings.\n--- --Set math format to percent.\n--- --Acquire 1 reading to use as the relative percent value.\n--- --Take 5 readings with percent math enabled and store them in a buffer called MathBuffer that can store 100 readings.\n--- --\u00a0\n--- --Take three additional readings without using the reading buffer.\n--- --\u00a0\n--- --Sample output assuming no load was connected to the instrument:\n--- ---100.00242 %, -100.00228 %, -100.00220 %, -100.00233 %, -100.00216 %\n--- ---100.00228175\n--- ---100.0022889\n--- ---100.00210915\n" - } - ], - "related_commands": [ - "Calculations that you can apply to measurements", - "dmm.digitize.math.enable", - "dmm.measure.math.format" - ] - }, - { - "name": "dmm.digitize.rel.acquire()", - "webhelpfile": "41236.htm", - "signature": "dmm.digitize.rel.acquire()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function acquires a measurement and stores it as the relative offset value for the selected digitize function.", - "details": "This command triggers the instrument to make a new measurement for the selected function. This measurement is then stored as the new relative offset level.When you send this command, the instrument does not apply any math, limit test, or filter settings to the measurement, even if they are set. It is a measurement that is made as if these settings are disabled.If an error event occurs during the measurement, nil is returned and the relative offset level remains at the last valid setting.You must change to the function for which you want to acquire a value before sending this command.The instrument must have relative offset enabled to use the acquired relative offset value.After executing this command, you can use the dmm.digitize.rel.level attribute to see the last relative level value that was acquired or that was set.", - "param_info": [ - { - "name": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENTrel_value = dmm.digitize.rel.acquire()dmm.digitize.rel.enable = dmm.ONprint(rel_value)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Acquires a relative offset level value for the digitize current function and turns the relative offset feature on.Output the value of the offset.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.digitize.rel.acquire()" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;rel_value = dmm.digitize.rel.acquire();dmm.digitize.rel.enable = dmm.ON;print(rel_value);", - "description": "Acquires a relative offset level value for the digitize current function and turns the relative offset feature on.\n--- --Output the value of the offset.\n" - } - ], - "related_commands": [ - "dmm.digitize.func", - "dmm.digitize.rel.enable", - "dmm.digitize.rel.level" - ] - }, - { - "name": "dmm.digitize.math.enable", - "webhelpfile": "41240.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables math operations on measurements for the selected digitize function.", - "details": "When this command is set to on, the math operation specified by the math format command is performed before completing a measurement.", - "param_info": [ - { - "name": "value", - "description": "The math enable setting", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmdigitizemathenablevalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizemathenablefunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.math.enable", - "dmm.digitize.math.enable = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_MATH_ENABLE)", - "dmm.measure.setattribute(function, ATTR_DIGI_MATH_ENABLE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.math.format = dmm.MATH_PERCENT;dmm.digitize.count = 1;dmm.digitize.math.percent = dmm.digitize.read();dmm.digitize.math.enable = dmm.ON;dmm.digitize.count = 5;MathBuffer = buffer.make(100);dmm.digitize.read(MathBuffer);printbuffer(1, MathBuffer.n, MathBuffer.formattedreadings);dmm.digitize.count = 1;for x = 1, 3 do ; print(dmm.digitize.read(MathBuffer));end;", - "description": "Configure the instrument for digitize voltage.\n--- --Set math format to percent. \n--- --Acquire 1 reading to use as the relative percent value.\n--- --Take 5 readings with percent math enabled and store them in a buffer called MathBuffer that can store 100 readings.\n--- --\u00a0\n--- --Take three additional readings.\n--- --\u00a0\n--- --Sample output assuming no load was connected to the instrument:\n--- ---100.00 %, -100.00 %, -100.00 %, -100.00 %, -100.00 %\n--- ---100.00058257\n--- ---99.999126228\n--- ---99.998932056\n" - } - ], - "related_commands": [ - "dmm.digitize.math.format" - ] - }, - { - "name": "dmm.digitize.math.format", - "webhelpfile": "41243.htm", - "signature": "", - "command_return": "operation", - "type": "Attribute (RW)", - "default_value": "dmm.MATH_PERCENT\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which math operation is performed on measurements when math operations are enabled.", - "details": "This specifies which math operation is performed on measurements for the selected digitize function.You can choose one of the following math operations:Math calculations are applied to the input signal after relative offset and before limit tests.", - "param_info": [ - { - "name": "operation", - "description": "Math operation to be performed on measurements", - "enum": "dmm.MATH_MXB nil|dmm.MATH_PERCENT nil|dmm.MATH_RECIPROCAL nil", - "type": "dmmdigitizemathformatoperation", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizemathformatfunction", - "range": "" - } - ], - "usage": [ - "operation = dmm.digitize.math.format", - "dmm.digitize.math.format = operation", - "operation = dmm.measure.getattribute(function, ATTR_DIGI_MATH_FORMAT)", - "dmm.measure.setattribute(function, ATTR_DIGI_MATH_FORMAT, operation)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.math.format = dmm.MATH_RECIPROCAL;dmm.digitize.math.enable = dmm.ON;", - "description": "Enables the reciprocal math operation on digitize voltage measurements.\n" - } - ], - "related_commands": [ - "dmm.digitize.math.enable" - ] - }, - { - "name": "dmm.measure.math.format", - "webhelpfile": "41245.htm", - "signature": "", - "command_return": "operation", - "type": "Attribute (RW)", - "default_value": "dmm.MATH_PERCENT\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies which math operation is performed on measurements when math operations are enabled.", - "details": "This specifies which math operation is performed on measurements for the selected measurement function.You can choose one of the following math operations:", - "param_info": [ - { - "name": "operation", - "description": "Math operation to be performed on measurements", - "enum": "dmm.MATH_MXB nil|dmm.MATH_PERCENT nil|dmm.MATH_RECIPROCAL nil", - "type": "dmmmeasuremathformatoperation", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "operation = dmm.measure.math.format", - "dmm.measure.math.format = operation", - "operation = dmm.measure.getattribute(function, ATTR_MEAS_MATH_FORMAT)", - "dmm.measure.setattribute(function, ATTR_MEAS_MATH_FORMAT, operation)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.math.format = dmm.MATH_RECIPROCAL;dmm.measure.math.enable = dmm.ON;", - "description": "Enables the reciprocal math operation on voltage measurements.\n" - } - ], - "related_commands": [ - "Calculations that you can apply to measurements", - "dmm.digitize.math.format", - "dmm.measure.math.enable" - ] - }, - { - "name": "dmm.measure.math.mxb.bfactor", - "webhelpfile": "41246.htm", - "signature": "", - "command_return": "offsetFactor", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the offset, b, for the y = mx + b operation.", - "details": "This attribute specifies the offset (b) for an mx + b operation.The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation:Where:", - "param_info": [ - { - "name": "offsetFactor", - "description": "The offset for the y = mx + b operation; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "offsetFactor = dmm.measure.math.mxb.bfactor", - "dmm.measure.math.mxb.bfactor = offsetFactor", - "offsetFactor = dmm.measure.getattribute(function, ATTR_MEAS_MATH_MXB_BF)", - "dmm.measure.setattribute(function, ATTR_MEAS_MATH_MXB_BF, offsetFactor)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.math.format = dmm.MATH_MXB;dmm.measure.math.mxb.mfactor = 0.80;dmm.measure.math.mxb.bfactor = 50;dmm.measure.math.enable = dmm.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the scale factor for the mx + b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "Calculations that you can apply to measurements", - "dmm.digitize.math.mxb.bfactor", - "dmm.measure.math.enable", - "dmm.measure.math.format", - "dmm.measure.math.mxb.mfactor" - ] - }, - { - "name": "dmm.measure.math.mxb.mfactor", - "webhelpfile": "41247.htm", - "signature": "", - "command_return": "scaleFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the scale factor, m, for the y = mx + b math operation.", - "details": "This command sets the scale factor (m) for an mx + b operation for the selected measurement function.The mx + b math operation lets you manipulate normal display readings (x) mathematically according to the following calculation:Where: ", - "param_info": [ - { - "name": "scaleFactor", - "description": "The scale factor; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "scaleFactor = dmm.measure.math.mxb.mfactor", - "dmm.measure.math.mxb.mfactor = scaleFactor", - "scaleFactor = dmm.measure.getattribute(function, ATTR_MEAS_MATH_MXB_MF)", - "dmm.measure.setattribute(function, ATTR_MEAS_MATH_MXB_MF, scaleFactor)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.math.format = dmm.MATH_MXB;dmm.measure.math.mxb.mfactor = 0.80;dmm.measure.math.mxb.bfactor = 50;dmm.measure.math.enable = dmm.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the scale factor for the mx +b operation to 0.80.\n--- --Set the offset factor to 50.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "Calculations that you can apply to measurements", - "dmm.digitize.math.mxb.mfactor", - "dmm.measure.math.enable", - "dmm.measure.math.format", - "dmm.measure.math.mxb.bfactor" - ] - }, - { - "name": "dmm.measure.math.percent", - "webhelpfile": "41248.htm", - "signature": "", - "command_return": "reference", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the reference constant that is used when math operations are set to percent.", - "details": "The percent math function displays measurements as percent deviation from a specified reference constant. The percent calculation is:Where:", - "param_info": [ - { - "name": "reference", - "description": "The reference used when the math operation is set to percent; the range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "reference = dmm.measure.math.percent", - "dmm.measure.math.percent = reference", - "reference = dmm.measure.getattribute(function, ATTR_MEAS_MATH_PERCENT)", - "dmm.measure.setattribute(function, ATTR_MEAS_MATH_PERCENT, reference)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.math.format = dmm.MATH_PERCENT;dmm.measure.math.percent = 50;dmm.measure.math.enable = dmm.ON;", - "description": "Set the measurement function to voltage.\n--- --Set the math operations to percent.\n--- --Set the reference constant to 50 for voltage measurements.\n--- --Enable math operations.\n" - } - ], - "related_commands": [ - "Calculations that you can apply to measurements", - "dmm.digitize.math.percent", - "dmm.measure.math.enable", - "dmm.measure.math.format" - ] - }, - { - "name": "dmm.digitize.math.mxb.bfactor", - "webhelpfile": "41252.htm", - "signature": "", - "command_return": "offsetFactor", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the offset, b, for the y = mx + b operation.", - "details": "This attribute specifies the offset (b) for an mx + b operation.The mx + b math operation lets you manipulate normal display readings (x) mathematically based on the calculation:Where:", - "param_info": [ - { - "name": "offsetFactor", - "description": "The offset for the y = mx + b operation; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizemathmxbbfactorfunction", - "range": "" - } - ], - "usage": [ - "offsetFactor = dmm.digitize.math.mxb.bfactor", - "dmm.digitize.math.mxb.bfactor = offsetFactor", - "offsetFactor = dmm.measure.getattribute(function, ATTR_DIGI_MATH_MXB_BF)", - "dmm.measure.setattribute(function, ATTR_DIGI_MATH_MXB_BF, offsetFactor)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.math.format = dmm.MATH_MXB;dmm.digitize.math.mxb.mfactor = 0.80;dmm.digitize.math.mxb.bfactor = 42;dmm.digitize.math.enable = dmm.ON;", - "description": "Set the digitize function to digitize current.\n--- --Set the scale factor for the mx + b operation to 0.80.\n--- --Set the offset factor to 42.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "dmm.digitize.math.enable", - "dmm.digitize.math.format", - "dmm.digitize.math.mxb.mfactor" - ] - }, - { - "name": "dmm.digitize.math.mxb.mfactor", - "webhelpfile": "41255.htm", - "signature": "", - "command_return": "scaleFactor", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the scale factor, m, for the y = mx + b math operation.", - "details": "This command sets the scale factor (m) for an mx + b operation for the selected measurement function.The mx + b math operation lets you manipulate normal display readings (x) mathematically according to the following calculation:Where: ", - "param_info": [ - { - "name": "scaleFactor", - "description": "The scale factor; the valid range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizemathmxbmfactorfunction", - "range": "" - } - ], - "usage": [ - "scaleFactor = dmm.digitize.math.mxb.mfactor", - "dmm.digitize.math.mxb.mfactor = scaleFactor", - "scaleFactor = dmm.measure.getattribute(function, ATTR_DIGI_MATH_MXB_MF)", - "dmm.measure.setattribute(function, ATTR_DIGI_MATH_MXB_MF, scaleFactor)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.math.format = dmm.MATH_MXB;dmm.digitize.math.mxb.mfactor = 0.80;dmm.digitize.math.mxb.bfactor = 42;dmm.digitize.math.enable = dmm.ON;", - "description": "Set the digitize function to digitize current.\n--- --Set the scale factor for the mx + b operation to 0.80.\n--- --Set the offset factor to 42.\n--- --Enable the math function.\n" - } - ], - "related_commands": [ - "dmm.digitize.math.enable", - "dmm.digitize.math.format", - "dmm.digitize.math.mxb.bfactor" - ] - }, - { - "name": "dmm.digitize.math.percent", - "webhelpfile": "41257.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute specifies the reference constant that is used when math operations are set to percent.", - "details": "The percent math function displays measurements as percent deviation from a specified reference constant. The percent calculation is:Where:", - "param_info": [ - { - "name": "value", - "description": "The reference used when the math operation is set to percent; the range is -1e12 to +1e12", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizemathpercentfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.math.percent", - "dmm.digitize.math.percent = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_MATH_PERCENT)", - "dmm.measure.setattribute(function, ATTR_DIGI_MATH_PERCENT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.math.format = dmm.MATH_PERCENT;dmm.digitize.math.percent = 42;dmm.digitize.math.enable = dmm.ON;", - "description": "Set the measurement function to digitize current.\n--- --Set the math operations to percent.\n--- --Set the percentage value to 42.\n--- --Enable math operations.\n" - } - ], - "related_commands": [ - "dmm.digitize.math.enable", - "dmm.digitize.math.format" - ] - }, - { - "name": "dmm.measure.offsetcompensation.enable", - "webhelpfile": "41259.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "4-wire resistance: dmm.OFFTemperature, 3-wire or 4-wire RTD: dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if offset compensation is used.", - "details": "", - "param_info": [ - { - "name": "state", - "description": "Set offset compensation to", - "enum": "dmm.OFF 4|dmm.ON nil|dmm.OCOMP_AUTO nil", - "type": "dmmmeasureoffsetcompensationenablestate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.offsetcompensation.enable", - "dmm.measure.offsetcompensation.enable = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_OFFCOMP_ENABLE)", - "dmm.measure.setattribute(function, ATTR_MEAS_OFFCOMP_ENABLE, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_FOURRTD;dmm.measure.offsetcompensation.enable = dmm.OCOMP_ON;print(dmm.measure.read());", - "description": "Sets the measurement function to resistance. Set the instrument for 4-wire RTD and turn offset compensation on.\n--- --Make a measurement.\n" - } - ], - "related_commands": [ - "dmm.measure.drycircuit " - ] - }, - { - "name": "dmm.measure.offsetcompensation.delay.auto", - "webhelpfile": "41261.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "Only available for the temperature function if the transducer is set to four RTD or three RTD.", - "param_info": [ - { - "name": "state", - "description": "Disable", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasureoffsetcompensationdelayautostate", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.offsetcompensation.delay.auto", - "dmm.measure.offsetcompensation.delay.auto = state" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_FOURRTD;dmm.measure.offsetcompensation.delay.auto = dmm.OFF;", - "description": "Describe\n" - } - ], - "related_commands": [ - "", - "dmm.measure.transducer" - ] - }, - { - "name": "dmm.measure.offsetcompensation.delay.currenton", - "webhelpfile": "41264.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "For temperature measurements, this command is only available for the temperature function if the transducer is set to four RTD or three RTD.", - "param_info": [ - { - "name": "value", - "description": "Delay in seconds", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.offsetcompensation.delay.currenton", - "dmm.measure.offsetcompensation.delay.currenton = value" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_FOURRTD;dmm.measure.offsetcompensation.delay.currenton = .1;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.measure.offsetcompensation.delay.currentoff", - "webhelpfile": "41267.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "Only available for the temperature function if the transducer is set to four\u2011wire RTD or three\u2011wire RTD.", - "param_info": [ - { - "name": "value", - "description": "Delay in seconds", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.offsetcompensation.delay.currentoff", - "dmm.measure.offsetcompensation.delay.currentoff = value" - ], - "overloads": [], - "examples": [ - { - "example": "group.attribute = 2;", - "description": "Describe\n" - } - ], - "related_commands": [ - "dmm.measure.transducer" - ] - }, - { - "name": "dmm.digitize.userdelay[N]", - "webhelpfile": "41269.htm", - "signature": "", - "command_return": "delayTime", - "type": "Attribute (RW)", - "default_value": "0 (0\u00a0s)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets a user-defined delay that you can use in the trigger model.", - "details": "To use this command in a trigger model, assign the delay to the dynamic delay block.The delay is specific to the selected function.", - "param_info": [ - { - "name": "delayTime", - "description": "The delay (0 for no delay, or 167\u00a0ns to 10 ks)", - "enum": "", - "type": "number", - "range": "(0 for no delay, or 167\u00a0ns to 10 ks)" - }, - { - "name": "N", - "description": "The user delay to which this time applies (1 to 5)", - "enum": "", - "type": "any", - "range": "(1 to 5)" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeuserdelayfunction", - "range": "" - } - ], - "usage": [ - "delayTime = dmm.digitize.userdelay[N]", - "dmm.digitize.userdelay[N] = delayTime", - "delayTime = dmm.measure.getattribute(function, ATTR_DIGI_USER_DELAY_N)", - "dmm.measure.setattribute(function, ATTR_DIGI_USER_DELAY_N, delayTime)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.userdelay[2] = 0.5;trigger.model.setblock(6, trigger.BLOCK_DELAY_DYNAMIC, trigger.USER_DELAY_M2);", - "description": "Set user delay 2 to be 0.5 s. Sets trigger-model block 6 to use the delay.\n" - } - ], - "related_commands": [ - "trigger.model.setblock() \u2014 trigger.BLOCK_DELAY_DYNAMIC" - ] - }, - { - "name": "dmm.measure.rel.enable", - "webhelpfile": "41271.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the application of a relative offset value to the measurement.", - "details": "When relative measurements are enabled, all subsequent measured readings are offset by the relative offset value. You can enter a relative offset value or have the instrument acquire a relative offset value.Each returned measured relative reading is the result of the following calculation:", - "param_info": [ - { - "name": "state", - "description": "The setting", - "enum": "dmm.ON nil|dmm.OFF nil", - "type": "dmmmeasurerelenablestate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.rel.enable", - "dmm.measure.rel.enable = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_REL_ENABLE)", - "dmm.measure.setattribute(function, ATTR_MEAS_REL_ENABLE, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_AC_CURRENT;dmm.measure.rel.acquire();dmm.measure.rel.enable = dmm.ON;", - "description": "Enables the relative measurements for AC current and uses the acquire command to set the relative level attribute.\n" - } - ], - "related_commands": [ - "dmm.digitize.rel.enable", - "dmm.measure.rel.acquire()", - "dmm.measure.rel.level", - "dmm.measure.rel.method" - ] - }, - { - "name": "dmm.measure.rel.acquire()", - "webhelpfile": "41272.htm", - "signature": "dmm.measure.rel.acquire()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function acquires a measurement and stores it as the relative offset value.", - "details": "This command triggers the instrument to make a new measurement for the selected function. This measurement is then stored as the new relative offset level.When you send this command, the instrument does not apply any math, limit test, or filter settings to the measurement, even if they are set. It is a measurement that is made as if these settings are disabled.If an error event occurs during the measurement, nil is returned and the relative offset level remains at the last valid setting.You must change to the function for which you want to acquire a value before sending this command.The instrument must have relative offset enabled to use the acquired relative offset value.After executing this command, you can use the dmm.measure.rel.level attribute to see the last relative level value that was acquired or that was set.", - "param_info": [ - { - "name": "dmm.FUNC_DC_VOLTAGE", - "description": "dmm.FUNC_RESISTANCE\ndmm.FUNC_ACV_FREQUENCY", - "enum": "dmm.FUNC_RESISTANCE nil|dmm.FUNC_ACV_FREQUENCY nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_AC_VOLTAGE", - "description": "dmm.FUNC_4W_RESISTANCE\ndmm.FUNC_ACV_PERIOD", - "enum": "dmm.FUNC_4W_RESISTANCE nil|dmm.FUNC_ACV_PERIOD nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_DC_CURRENT", - "description": "dmm.FUNC_DIODE \ndmm.FUNC_DCV_RATIO", - "enum": "dmm.FUNC_DIODE nil|dmm.FUNC_DCV_RATIO nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_AC_CURRENT", - "description": "dmm.FUNC_CAPACITANCE\ndmm.FUNC_DIGITIZE_CURRENT", - "enum": "dmm.FUNC_CAPACITANCE nil|dmm.FUNC_DIGITIZE_CURRENT nil", - "type": "any", - "range": "" - }, - { - "name": "dmm.FUNC_TEMPERATURE", - "description": "dmm.FUNC_CONTINUITY\ndmm.FUNC_DIGITIZE_VOLTAGE", - "enum": "dmm.FUNC_CONTINUITY nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.measure.rel.acquire()" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;rel_value = dmm.measure.rel.acquire();dmm.measure.rel.enable = dmm.ON;print(rel_value);", - "description": "Acquires a relative offset level value for voltage measurements, turns the relative offset feature on, and outputs the value.\n" - } - ], - "related_commands": [ - "dmm.digitize.rel.acquire()", - "dmm.measure.rel.enable", - "dmm.measure.rel.level" - ] - }, - { - "name": "dmm.measure.rel.level", - "webhelpfile": "41273.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the relative offset value.", - "details": "This command specifies the relative offset value that can be applied to new measurements. When relative offset is enabled, all subsequent measured readings are offset by the value that is set for this\u00a0command.You can set this value, or have the instrument acquire a value. If the instrument acquires the value, read this setting to return the value that was measured\u00a0internally.The ranges for the relative offset values for all functions are listed in the following table.", - "param_info": [ - { - "name": "value", - "description": "Relative offset value for measurements; see Details", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.rel.level", - "dmm.measure.rel.level = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_REL_LEVEL)", - "dmm.measure.setattribute(function, ATTR_MEAS_REL_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.rel.level = dmm.measure.read();dmm.measure.rel.enable = dmm.ON;", - "description": "Set the measure function to DC current.\n--- --Set the relative offset level to be the reading with any calculations included.\n--- --Enable the relative offset.\n" - } - ], - "related_commands": [ - "Relative offset", - "dmm.digitize.rel.level", - "dmm.measure.rel.acquire()", - "dmm.measure.rel.enable" - ] - }, - { - "name": "dmm.digitize.rel.level", - "webhelpfile": "41275.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the relative offset value.", - "details": "This command specifies the relative offset value that can be applied to new digitized measurements. When relative offset is enabled, all subsequent digitized readings are offset by the value that is set for this command.You can set this value, or have the instrument acquire a value. If the instrument acquires the value, read this setting to return the value that was measured internally.", - "param_info": [ - { - "name": "value", - "description": "Relative offset value for digitized measurements", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizerellevelfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.rel.level", - "dmm.digitize.rel.level = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_REL_LEVEL)", - "dmm.measure.setattribute(function, ATTR_DIGI_REL_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.rel.level = dmm.digitize.read();dmm.digitize.rel.enable = dmm.ON;", - "description": "Set the digitize function to digitize current.\n--- --Set the relative offset level to be the reading with any calculations included.\n--- --Enable the relative offset.\n" - } - ], - "related_commands": [ - "dmm.digitize.rel.acquire()", - "dmm.digitize.rel.enable" - ] - }, - { - "name": "dmm.digitize.rel.enable", - "webhelpfile": "41280.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the application of a relative offset value to the measurement.", - "details": "When relative measurements are enabled, all subsequent digitized readings are offset by the relative offset value that was calculated when you acquired the relative offset value.Each returned measured relative reading is the result of the following calculation:", - "param_info": [ - { - "name": "state", - "description": "The setting", - "enum": "dmm.ON nil|dmm.OFF nil", - "type": "dmmdigitizerelenablestate", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizerelenablefunction", - "range": "" - } - ], - "usage": [ - "state = dmm.digitize.rel.enable", - "dmm.digitize.rel.enable = state", - "state = dmm.measure.getattribute(function, ATTR_DIGI_REL_ENABLE)", - "dmm.measure.setattribute(function, ATTR_DIGI_REL_ENABLE, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.rel.acquire();dmm.digitize.rel.enable = dmm.ON;", - "description": "Enables the relative measurements for digitize current after using the acquire command to set the relative level.\n" - } - ], - "related_commands": [ - "dmm.digitize.rel.acquire()", - "dmm.digitize.rel.level" - ] - }, - { - "name": "dmm.measure.threshold.range", - "webhelpfile": "41283.htm", - "signature": "", - "command_return": "range", - "type": "Attribute (RW)", - "default_value": "10 (10 V)\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the expected input level of the voltage signal.", - "details": "The range setting conditions the signal. The instrument automatically selects the most sensitive threshold range for the value you enter. For example, if you specify the expected input voltage to be 90\u00a0mV, the instrument automatically selects the\u00a0100 mV threshold range.", - "param_info": [ - { - "name": "range", - "description": "The range", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "range = dmm.measure.threshold.range", - "dmm.measure.threshold.range = range", - "range = dmm.measure.getattribute(function, ATTR_MEAS_THRESHOLD_RANGE)", - "dmm.measure.setattribute(function, ATTR_MEAS_THRESHOLD_RANGE, range)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_ACV_PERIOD;dmm.measure.threshold.range = 50;", - "description": "Set the threshold range for the selected function to the nearest range of 100\u00a0V.\n" - } - ], - "related_commands": [ - "dmm.measure.threshold.autorange", - "dmm.measure.threshold.level" - ] - }, - { - "name": "dmm.measure.threshold.level", - "webhelpfile": "41287.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the signal level where the instrument makes frequency or period measurements.", - "details": "You need to set an appropriate voltage trigger level in order for the frequency counter to operate properly. The frequency counter only counts cycles when the signal amplitude reaches the trigger level. For example, if you set the trigger level for 10\u00a0V, any cycles with peak amplitude less than 10\u00a0V are not counted.You must select a specific threshold range (autorange must be set to off) before setting a level that is not zero.", - "param_info": [ - { - "name": "value", - "description": "The level", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.threshold.level", - "dmm.measure.threshold.level = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_THRESHOLD_LEVEL)", - "dmm.measure.setattribute(function, ATTR_MEAS_THRESHOLD_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_ACV_FREQUENCY;dmm.measure.threshold.range = 10;dmm.measure.threshold.level = 5;", - "description": "Set the measure function to frequency.\n--- --Set the threshold range to 10\u00a0V.\n--- --Set the threshold level to 5\u00a0V.\n" - } - ], - "related_commands": [ - "dmm.measure.threshold.autorange", - "dmm.measure.threshold.range" - ] - }, - { - "name": "dmm.measure.threshold.autorange", - "webhelpfile": "41289.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the threshold range is set manually or automatically.", - "details": "This command determines how the range is selected.When this command is set to off, you must set the range. If you do not set the range, the instrument remains at the range that was last selected by autorange.When this command is set to on, the instrument uses the signal to determine the most sensitive range on which to perform the measurement. The instrument sets the range when a measurement is requested. To set the range, the instrument makes a measurement to determine the range before making the final measurement, which can result in slower reading times. Turn autorange off and set a specific range to increase measure time.If a range is manually selected through the front panel or a remote command, this command is automatically set to off.", - "param_info": [ - { - "name": "state", - "description": "The auto range setting", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasurethresholdautorangestate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.threshold.autorange", - "dmm.measure.threshold.autorange = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_THRESHOLD_RANGE_AUTO)", - "dmm.measure.setattribute(function, ATTR_MEAS_THRESHOLD_RANGE_AUTO, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_ACV_PERIOD;dmm.measure.threshold.autorange = dmm.ON;", - "description": "Set the measure function to period.\n--- --Set the threshold autorange on.\n" - } - ], - "related_commands": [ - "dmm.measure.threshold.level", - "dmm.measure.threshold.range" - ] - }, - { - "name": "dmm.measure.count", - "webhelpfile": "41296.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements to make when a measurement is requested.", - "details": "This command sets the number of measurements that are made when a measurement is requested. This command does not affect the trigger model.When dmm.measure.count or if the function for dmm.measure.setattribute is the active function, this command sets the count for all measure functions. When you send dmm.measure.setattribute for a function that is not active, only the count for the specified function is changed.If you set the count to a value that is larger than the capacity of the reading buffer and the buffer fill mode is set to continuous, the buffer wraps until the number of readings specified have occurred. The earliest readings in the count are overwritten. If the buffer is set to fill once, readings stop when the buffer is filled, even if the count is not complete.", - "param_info": [ - { - "name": "count", - "description": "The number of measurements to make when a measurement is requested (maximum 1,000,000 or buffer capacity)", - "enum": "", - "type": "number", - "range": "(maximum 1,000,000 or buffer capacity)" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "count = dmm.measure.count", - "dmm.measure.count = count", - "count = dmm.measure.getattribute(function, ATTR_MEAS_COUNT)", - "dmm.measure.setattribute(function, ATTR_MEAS_COUNT, count)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.count = 10;dmm.measure.read();", - "description": "Set the instrument to make 10 measurements.\n--- --Request 10 measurements.\n" - } - ], - "related_commands": [ - "dmm.digitize.count", - "dmm.measure.read()", - "dmm.measure.readwithtime()", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "dmm.digitize.count", - "webhelpfile": "41297.htm", - "signature": "", - "command_return": "count", - "type": "Attribute (RW)", - "default_value": "10,000\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the number of measurements to digitize when a measurement is requested.", - "details": "The digitize function makes the number of readings set by this command in the time set by the sample rate. This command does not affect the trigger model.", - "param_info": [ - { - "name": "count", - "description": "The number of measurements to make (1 to 55,000,000 or buffer capacity)", - "enum": "", - "type": "any", - "range": "(1 to 55,000,000 or buffer capacity)" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizecountfunction", - "range": "" - } - ], - "usage": [ - "count = dmm.digitize.count", - "dmm.digitize.count = count", - "count = dmm.measure.getattribute(function, ATTR_DIGI_COUNT)", - "dmm.measure.setattribute(function, ATTR_DIGI_COUNT, count)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.aperture = dmm.APERTURE_AUTO;dmm.digitize.samplerate = 1000000;dmm.digitize.count = 10;print(dmm.digitize.read());", - "description": "Set the digitize function to measure current. Set the sample rate to 1,000,000, with a count of 10, and automatic aperture.\n--- --Make a digitize measurement.\n--- --Example output:\n--- ---0.0039799990218\n" - } - ], - "related_commands": [ - "Digitize functions", - "dmm.digitize.aperture", - "dmm.digitize.samplerate" - ] - }, - { - "name": "dmm.measure.nplc", - "webhelpfile": "41301.htm", - "signature": "", - "command_return": "nplc", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This command sets the time that the input signal is measured for the selected function.", - "details": "This command sets the amount of time that the input signal is measured.The amount of time is specified as the number of power line cycles (NPLCs). Each PLC for 60\u00a0Hz is 16.67\u00a0ms (1/60) and each PLC for 50\u00a0Hz is 20\u00a0ms (1/50). For 60\u00a0Hz, if you set the NPLC to 0.1, the measure time is 1.667 ms.The shortest amount of time results in the fastest reading rate but increases the reading noise and decreases the number of usable digits.The longest amount of time provides the lowest reading noise and more usable digits but has the slowest reading rate.Settings between the fastest and slowest number of power line cycles are a compromise between speed and noise.If you change the PLCs, you may want to adjust the displayed digits to reflect the change in usable digits.", - "param_info": [ - { - "name": "nplc", - "description": "The number of power line cycles", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "nplc = dmm.measure.nplc", - "dmm.measure.nplc = nplc", - "nplc = dmm.measure.getattribute(function, ATTR_MEAS_NPLC)", - "dmm.measure.setattribute(function, ATTR_MEAS_NPLC, nplc)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.nplc = 0.5;", - "description": "Sets the measurement function to DC voltage. Set the NPLC value to 0.5.\n" - } - ], - "related_commands": [ - "dmm.measure.aperture", - "dmm.measure.linesync", - "Using aperture or NPLCs to adjust speed and accuracy" - ] - }, - { - "name": "dmm.measure.opendetector", - "webhelpfile": "41303.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "4W Res: dmm.OFFTemperature: dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the detection of open leads is enabled or disabled.", - "details": "For temperature measurements, this is only available when the transducer is set to a thermocouple or one of the RTDs.Long lengths of thermocouple wire can have a large amount of capacitance, which is seen at the input of the DMM. If an intermittent open occurs in the thermocouple circuit, the capacitance can cause an erroneous on-scale reading. The open thermocouple detection circuit, when enabled, applies a 100\u00a0\u00b5A pulse of current to the thermocouple before the start of each temperature measurement.", - "param_info": [ - { - "name": "state", - "description": "Disable open lead detector", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasureopendetectorstate", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.opendetector", - "dmm.measure.opendetector = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_OPEN_DETECTOR)", - "dmm.measure.setattribute(function, ATTR_MEAS_OPEN_DETECTOR, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_TEMPERATURE;dmm.measure.transducer = dmm.TRANS_THERMOCOUPLE;dmm.measure.opendetector = dmm.OFF;", - "description": "Set the measure function to temperature.\n--- --Set the transducer type to thermocouple.\n--- --Set open lead detection off.\n" - } - ], - "related_commands": [ - "dmm.measure.transducer", - "Open lead detection" - ] - }, - { - "name": "dmm.measure.range", - "webhelpfile": "41304.htm", - "signature": "", - "command_return": "rangeValue", - "type": "Attribute (RW)", - "default_value": "See Details\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale measure range.", - "details": "You can assign any real number using this command. The instrument selects the closest fixed range that is large enough to measure the entered number. For example, for current measurements, if you expect a reading of approximately 9\u00a0mA, set the range to 9 mA to select the 10\u00a0mA range. When you read this setting, you see the positive full-scale value of the measurement range that the instrument is presently using.This command is primarily intended to eliminate the time that is required by the instrument to automatically search for a range.When a range is fixed, any signal greater than the entered range generates an overrange condition. When an overrange condition occurs, the front panel displays \"Overflow\" and the remote interface returns 9.9e+37.The following table lists the ranges for each function.", - "param_info": [ - { - "name": "rangeValue", - "description": "See Details", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "rangeValue = dmm.measure.range", - "dmm.measure.range = rangeValue", - "rangeValue = dmm.measure.getattribute(function, ATTR_MEAS_RANGE)", - "dmm.measure.setattribute(function, ATTR_MEAS_RANGE, rangeValue)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_AC_VOLTAGE;dmm.measure.range = 90;print(dmm.measure.range);", - "description": "Set the range to 90\u00a0V, which selects the 100\u00a0V range.\n--- --Output:\n--- --100\n" - } - ], - "related_commands": [ - "dmm.digitize.range", - "dmm.measure.autorange" - ] - }, - { - "name": "dmm.digitize.range", - "webhelpfile": "41306.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Current: 1\u00a0AVoltage: 10 V\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale measure range for the selected digitize function.", - "details": "When you assign a range value, the instrument selects a fixed range that is large enough to measure the assigned value. The instrument selects the best range for measuring the maximum expected value.For example, for digitize current measurements, if you expect a reading of approximately 9\u00a0mA, set the range to 9 mA to select the 10\u00a0mA range.When you read this setting, you see the positive full-scale value of the measurement range that the instrument is presently using.", - "param_info": [ - { - "name": "value", - "description": "Set to the maximum expected value to be measured", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizerangefunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.range", - "dmm.digitize.range = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_RANGE)", - "dmm.measure.setattribute(function, ATTR_DIGI_RANGE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.range = 90;", - "description": "Set the function to digitize voltage. Set the range to 90\u00a0V, which selects the 100\u00a0V range.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dmm.measure.unit", - "webhelpfile": "41308.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Temperature: dmm.UNIT_CELSIUSVoltage: dmm.UNIT_VOLT\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.", - "details": "The change in measurement units is displayed when the next measurement is made. You can only change the units for the listed functions.", - "param_info": [ - { - "name": "value", - "description": "For DC volts and AC volts, select from the following units", - "enum": "dmm.UNIT_VOLT nil|dmm.UNIT_DB nil|dmm.UNIT_DBM nil|dmm.UNIT_CELSIUS nil|dmm.UNIT_KELVIN nil|dmm.UNIT_FAHRENHEIT nil", - "type": "dmmmeasureunitvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.unit", - "dmm.measure.unit = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_UNIT)", - "dmm.measure.setattribute(function, ATTR_MEAS_UNIT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.unit = dmm.UNIT_DB;", - "description": "Changes the front-panel display and buffer readings for voltage measurements to be displayed as decibel readings.\n" - } - ], - "related_commands": [ - "dmm.digitize.unit" - ] - }, - { - "name": "dmm.terminals", - "webhelpfile": "41309.htm", - "signature": "", - "command_return": "terminals", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute describes which set of input and output terminals the instrument is using.", - "details": "You must use the front-panel TERMINALS switch to change which set of terminals the instrument reads.", - "param_info": [ - { - "name": "terminals", - "description": "Using the front-panel input and output terminals", - "enum": "dmm.TERMINALS_FRONT nil|dmm.TERMINALS_REAR nil", - "type": "dmmterminalsterminals", - "range": "" - } - ], - "usage": [ - "terminals = dmm.terminals" - ], - "overloads": [], - "examples": [ - { - "example": "print(dmm.terminals);", - "description": "Request information on which terminals are used.\n--- --Output if the instrument is using the front terminals:\n--- --dmm.TERMINALS_FRONT\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.extin.clear()", - "webhelpfile": "41331.htm", - "signature": "trigger.extin.clear()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function clears the trigger event on the external in line.", - "details": "The event detector of a trigger enters the detected state when an event is detected. This command clears the event detector, discards the history, and clears the overrun status (sets the overrun status to false).", - "param_info": [ - { - "name": "trigger.extin.clear()", - "description": "Clears the trigger event detector on I/O line 2.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.extin.clear()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.extin.clear();", - "description": "Clears the trigger event detector on I/O line 2.\n" - } - ], - "related_commands": [ - "trigger.extin.overrun" - ] - }, - { - "name": "trigger.extin.edge", - "webhelpfile": "41332.htm", - "signature": "", - "command_return": "detectedEdge", - "type": "Attribute (RW)", - "default_value": "trigger.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the type of edge that is detected as an input on the external trigger in line.", - "details": "The input state of the external I/O line is controlled by the type of edge specified by this command.", - "param_info": [ - { - "name": "detectedEdge", - "description": "The trigger edge value", - "enum": "trigger.EDGE_FALLING nil|trigger.EDGE_RISING nil|trigger.EDGE_EITHER nil", - "type": "triggerextinedgedetectedEdge", - "range": "" - } - ], - "usage": [ - "detectedEdge = trigger.extin.edge", - "trigger.extin.edge = detectedEdge" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.extin.edge = trigger.EDGE_RISING;", - "description": "Sets the external I/O input line to detect rising-edge triggers as inputs.\n" - } - ], - "related_commands": [ - "trigger.extout.logic", - "trigger.extout.stimulus" - ] - }, - { - "name": "trigger.extin.overrun", - "webhelpfile": "41333.htm", - "signature": "", - "command_return": "overrun", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the event detector overrun status.", - "details": "If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.", - "param_info": [ - { - "name": "overrun", - "description": "Trigger overrun state (true or false)", - "enum": "", - "type": "boolean", - "range": "(true or false)" - } - ], - "usage": [ - "overrun = trigger.extin.overrun" - ], - "overloads": [], - "examples": [ - { - "example": "overrun = trigger.extin.overrun;print(overrun);", - "description": "If there is no trigger overrun on the external input, the output is:\n--- --false\n" - } - ], - "related_commands": [ - "trigger.ext.reset()" - ] - }, - { - "name": "trigger.extin.wait()", - "webhelpfile": "41334.htm", - "signature": "trigger.extin.wait(timeout)", - "command_return": "triggered", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function waits for a trigger.", - "details": "This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time trigger.extin.wait() or trigger.extin.clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and is ready to detect the next trigger. This is true regardless of the number of events detected.", - "param_info": [ - { - "name": "triggered", - "description": "Trigger detected", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "timeout", - "description": "Timeout in seconds", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "triggered = trigger.extin.wait(timeout)" - ], - "overloads": [], - "examples": [ - { - "example": "triggered = trigger.extin.wait(3);print(triggered);", - "description": "Waits up to 3 s for a trigger to be detected on the external trigger line, then outputs the results.\n--- --Output if no trigger is detected:\n--- --false\n--- --Output if a trigger is detected:\n--- --true\n" - } - ], - "related_commands": [ - "trigger.extin.clear()" - ] - }, - { - "name": "trigger.extout.assert()", - "webhelpfile": "41335.htm", - "signature": "trigger.extout.assert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function asserts a trigger on the external output line.", - "details": "Initiates a trigger event and does not wait for completion.", - "param_info": [ - { - "name": "trigger.extout.assert()", - "description": "Asserts a trigger on external output line 2.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.extout.assert()" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.extout.assert();", - "description": "Asserts a trigger on external output line 2.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.extout.logic", - "webhelpfile": "41336.htm", - "signature": "", - "command_return": "logicType", - "type": "Attribute (RW)", - "default_value": "trigger.LOGIC_NEGATIVE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the output logic of the trigger event generator to positive or negative for the external I/O out line. ", - "details": "This command sets the trigger event generator to assert a TTL pulse for output logic. Positive is a high pulse; negative is a low pulse.", - "param_info": [ - { - "name": "logicType", - "description": "The output logic of the trigger generator", - "enum": "trigger.LOGIC_POSITIVE nil|trigger.LOGIC_NEGATIVE nil", - "type": "triggerextoutlogiclogicType", - "range": "" - } - ], - "usage": [ - "logicType = trigger.extout.logic", - "trigger.extout[N].logic = logicType" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.ext.reset();trigger.extin.clear() ;trigger.extout.logic = trigger.LOGIC_NEGATIVE;trigger.extout.stimulus = trigger.EVENT_EXTERNAL;trigger.extin.edge = trigger.EDGE_FALLING;", - "description": "Reset the external I/O line values to their defaults.\n--- --Clear any event triggers on the external input line.\n--- --Set the output logic to negative (it asserts a low pulse).\n--- --Set the stimulus to the external I/O input.\n--- --Set the external input to detect a falling edge.\n" - } - ], - "related_commands": [ - "trigger.ext.reset()" - ] - }, - { - "name": "trigger.extout.release()", - "webhelpfile": "41337.htm", - "signature": "trigger.digout[N].release()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function releases an indefinite length or latched trigger.", - "details": "Releases a trigger that was asserted with an indefinite pulse width time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.Releases a trigger that was asserted with an indefinite pulsewidth time. It also releases a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line is affected.*** ", - "param_info": [ - { - "name": "N", - "description": "Digital I/O trigger line (1 to 6)", - "enum": "", - "type": "any", - "range": "(1 to 6)" - } - ], - "usage": [ - "trigger.digout[N].release()" - ], - "overloads": [], - "examples": [ - { - "example": "digio.trigger[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - }, - { - "example": "digio.line[4].mode = digio.MODE_TRIGGER_OUT;trigger.digout[4].release();", - "description": "Releases digital I/O trigger line 4.\n" - } - ], - "related_commands": [ - "digio.trigger[N].assert()", - "digio.trigger[N].pulsewidth", - "digio.line[N].mode", - "Digital I/O port configuration", - "trigger.digout[N].assert()", - "trigger.digout[N].pulsewidth" - ] - }, - { - "name": "trigger.extout.stimulus", - "webhelpfile": "41338.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "trigger.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the event that causes a trigger to be asserted on the external output line.", - "details": "The trigger stimulus for the external output line can be set to one of the trigger events described in the following table.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "triggerEvents", - "range": "" - } - ], - "usage": [ - "event = trigger.extout.stimulus", - "trigger.extout.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.extout.stimulus = trigger.EVENT_TIMER3;", - "description": "Set the stimulus for the external output line to be the expiration of trigger timer\u00a03.\n" - } - ], - "related_commands": [ - "trigger.extin.edge", - "trigger.extin.wait()", - "trigger.extout.assert()", - "trigger.extout.logic" - ] - }, - { - "name": "trigger.ext.reset()", - "webhelpfile": "41343.htm", - "signature": "trigger.ext.reset()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function resets the edge, logic, and stimulus values for the external in/out line to their default values.", - "details": "This function resets the following attributes to their default values:It also clears trigger.extin.overrun.", - "param_info": [ - { - "name": "-- Set the external I/O trigger line for a rising edgetrigger.extin.edge = trigger.EDGE_RISING-- Set the logic to negativetrigger.extout.logic = trigger.LOGIC_NEGATIVE-- Set the stimulus to timer 3trigger.extout.stimulus = trigger.EVENT_TIMER3-- Print configuration (before reset)print(trigger.extin.edge, trigger.extout.logic, trigger.extout.stimulus)-- Reset the external I/O trigger line to default values.trigger.ext.reset()-- Print configuration (after reset)print(trigger.extin.edge, trigger.extout.logic, trigger.extout.stimulus)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Output before reset:trigger.EDGE_RISING trigger.LOGIC_NEGATIVE trigger.EVENT_TIMER3\u00a0Output after reset:trigger.EDGE_FALLING trigger.LOGIC_NEGATIVE trigger.EVENT_NONE", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.ext.reset()" - ], - "overloads": [], - "examples": [ - { - "example": "-- Set the external I/O trigger line for a rising edge;trigger.extin.edge = trigger.EDGE_RISING;-- Set the logic to negative;trigger.extout.logic = trigger.LOGIC_NEGATIVE;-- Set the stimulus to timer 3;trigger.extout.stimulus = trigger.EVENT_TIMER3;-- Print configuration (before reset);print(trigger.extin.edge, trigger.extout.logic, trigger.extout.stimulus);-- Reset the external I/O trigger line to default values.;trigger.ext.reset();-- Print configuration (after reset);print(trigger.extin.edge, trigger.extout.logic, trigger.extout.stimulus);", - "description": "Output before reset:\n--- --trigger.EDGE_RISING trigger.LOGIC_NEGATIVE trigger.EVENT_TIMER3\n--- --\u00a0\n--- --Output after reset:\n--- --trigger.EDGE_FALLING trigger.LOGIC_NEGATIVE trigger.EVENT_NONE\n" - } - ], - "related_commands": [ - "trigger.extin.edge", - "trigger.extout.logic", - "trigger.extout.stimulus" - ] - }, - { - "name": "channel.enable", - "webhelpfile": "41359.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "scanner.enable = ON or OFFScanner card support. Do we want scanner or go with scan? Not intended to support scan like 37xx so scanner may be a better prefix but, for SCPI can't support SCAN and SCAN as short form to SCANner", - "param_info": [ - { - "name": "value", - "description": "Describe value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = group.attribute", - "group.attribute = value" - ], - "overloads": [], - "examples": [ - { - "example": "group.attribute = 2;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.digitize.coupling.type", - "webhelpfile": "41380.htm", - "signature": "", - "command_return": "couplingType", - "type": "Attribute (RW)", - "default_value": "dmm.COUPLING_DC\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if AC or DC signal coupling is used.", - "details": "This command selects the type of input coupling that is used for the selected function.When DC is selected, the instrument measures AC and DC components of the signal. When AC is selected, the instrument only measures the AC components of the signal.If AC coupling is selected, you can change input impedance settings, but they do not take effect until DC coupling is selected.", - "param_info": [ - { - "name": "couplingType", - "description": "The type of coupling", - "enum": "dmm.COUPLING_AC nil|dmm.COUPLING_DC nil", - "type": "dmmdigitizecouplingtypecouplingType", - "range": "" - } - ], - "usage": [ - "couplingType = dmm.digitize.coupling.type", - "dmm.digitize.coupling.type = couplingType", - "couplingType = dmm.measure.getattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_COUPLING_TYPE)", - "dmm.measure.setattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_COUPLING_TYPE, couplingType)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.coupling.type = dmm.COUPLING_AC;", - "description": "Set the digitize voltage coupling to AC.\n" - } - ], - "related_commands": [ - "DC and AC coupling", - "dmm.digitize.coupling.acfilter", - "dmm.digitize.coupling.acfrequency" - ] - }, - { - "name": "dmm.digitize.analogtrigger.pulse.condition", - "webhelpfile": "41385.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.CONDITION_GREATER\n", - "tsp_link": "Yes\n", - "description": "This attribute defines if the pulse must be greater than or less than the incoming pulse must have a duration greater than or less than the threshold pulse width before an analog trigger is generated.", - "details": "Only available when the analog trigger mode is set to pulse.", - "param_info": [ - { - "name": "value", - "description": "The setting", - "enum": "dmm.CONDITION_GREATER nil|dmm.CONDITION_LESS nil", - "type": "dmmdigitizeanalogtriggerpulseconditionvalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerpulseconditionfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.pulse.condition", - "dmm.digitize.analogtrigger.pulse.condition = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_PULSE_CONDITION)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_PULSE_CONDITION, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_PULSE;dmm.digitize.analogtrigger.pulse.level = 5;dmm.digitize.analogtrigger.pulse.width = 30e-6;dmm.digitize.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.digitize.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set function to digitize voltage.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.func", - "dmm.digitize.analogtrigger.pulse.level", - "dmm.digitize.analogtrigger.pulse.polarity", - "dmm.digitize.analogtrigger.pulse.width", - "dmm.measure.analogtrigger.pulse.condition" - ] - }, - { - "name": "dmm.measure.analogtrigger.pulse.condition", - "webhelpfile": "41387.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.CONDITION_GREATER\n", - "tsp_link": "Yes\n", - "description": "This attribute defines if the pulse must be greater than or less than the incoming pulse must have a duration greater than or less than the threshold pulse width before an analog trigger is generated.", - "details": "Only available when the analog trigger mode is set to pulse.", - "param_info": [ - { - "name": "value", - "description": "The setting", - "enum": "dmm.CONDITION_GREATER nil|dmm.CONDITION_LESS nil", - "type": "dmmmeasureanalogtriggerpulseconditionvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.pulse.condition", - "dmm.measure.analogtrigger.pulse.condition = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_PULSE_CONDITION)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_PULSE_CONDITION, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.range = 10;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_PULSE;dmm.measure.analogtrigger.pulse.level = 5;dmm.measure.analogtrigger.pulse.width = 30e-6;dmm.measure.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.measure.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set measure function to DC voltage.\n--- --Set range to 10\u00a0V.\n--- --Disable autozero.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.pulse.condition", - "dmm.measure.analogtrigger.pulse.level", - "dmm.measure.analogtrigger.pulse.polarity", - "dmm.measure.analogtrigger.pulse.width" - ] - }, - { - "name": "dmm.measure.analogtrigger.mode", - "webhelpfile": "41389.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "dmm.MODE_OFF\n", - "tsp_link": "Yes\n", - "description": " This attribute configures the type of signal behavior that can generate an analog trigger event.", - "details": "When edge is selected, the analog trigger occurs when the signal crosses a certain level. You also specify if the analog trigger occurs on the rising or falling edge of the signal.When pulse is selected, the analog trigger occurs when a pulse passes through the specified level and meets the constraint that you set on its width. You also specify the polarity of the signal (above or below the trigger level).When window is selected, the analog trigger occurs when the signal enters or exits the window defined by the low and high signal levels.", - "param_info": [ - { - "name": "setting", - "description": "The mode setting", - "enum": "dmm.MODE_EDGE nil|dmm.MODE_PULSE nil|dmm.MODE_WINDOW nil|dmm.MODE_OFF nil", - "type": "dmmmeasureanalogtriggermodesetting", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "setting = dmm.measure.analogtrigger.mode", - "dmm.measure.analogtrigger.mode = setting", - "setting = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_MODE)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_MODE, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.range = 3;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_EDGE;dmm.measure.analogtrigger.edge.level = 2.5;dmm.measure.analogtrigger.edge.slope = dmm.SLOPE_FALLING;", - "description": "Set measure function to DC current.\n--- --Set range to 3\u00a0A.\n--- --Disable autozero.\n--- --Set the analog trigger mode to edge.\n--- --Set the analog trigger level to 2.5\u00a0A.\n--- --Set the level to be detected on a falling edge.\n" - } - ], - "related_commands": [ - "Analog triggering example with digitize function", - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode" - ] - }, - { - "name": "dmm.digitize.analogtrigger.mode", - "webhelpfile": "41391.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "dmm.MODE_OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute configures the type of signal behavior that can generate an analog trigger event.", - "details": "When edge is selected, the analog trigger occurs when the signal crosses a certain level. You also specify if the analog trigger occurs on the rising or falling edge of the signal.When pulse is selected, the analog trigger occurs when a pulse passes through the specified level and meets the constraint that you set on its width. You also specify the polarity of the signal (above or below the trigger level).When window is selected, the analog trigger occurs when the signal enters or exits the window defined by the low and high signal levels.", - "param_info": [ - { - "name": "setting", - "description": "The mode setting", - "enum": "dmm.MODE_EDGE nil|dmm.MODE_PULSE nil|dmm.MODE_WINDOW nil|dmm.MODE_OFF nil", - "type": "dmmdigitizeanalogtriggermodesetting", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggermodefunction", - "range": "" - } - ], - "usage": [ - "setting = dmm.digitize.analogtrigger.mode", - "dmm.digitize.analogtrigger.mode = setting", - "setting = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_MODE)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_MODE, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.range = 90;dmm.digitize.analogtrigger.mode = dmm.MODE_EDGE;dmm.digitize.analogtrigger.edge.level = 5;dmm.digitize.analogtrigger.edge.slope = dmm.SLOPE_FALLING;", - "description": "Set the function to digitize voltage.\n--- --Set the range to 90, which selects a range of 100\u00a0V.\n--- --Set the analog trigger mode to edge.\n--- --Set the level sense to 5\u00a0V.\n--- --Set the level to be detected on a falling edge.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.measure.analogtrigger.mode" - ] - }, - { - "name": "dmm.digitize.analogtrigger.edge.level", - "webhelpfile": "41394.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the signal level that generates the analog trigger event for the edge trigger mode.", - "details": "This command is only available when the analog trigger mode is set to edge.The edge level can be set to any value in the active measurement range. See the DMM7510 specifications for more information on the resolution and accuracy of the analog trigger.", - "param_info": [ - { - "name": "value", - "description": "The signal level that generates the analog trigger event", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggeredgelevelfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.edge.level", - "dmm.digitize.analogtrigger.edge.level = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_EDGE_LEVEL)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_EDGE_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_EDGE;dmm.digitize.analogtrigger.edge.level = 5;dmm.digitize.analogtrigger.edge.slope = dmm.SLOPE_FALLING;", - "description": "Set the function to digitize voltage.\n--- --Set the analog trigger mode to edge.\n--- --Set the level to sense 5\u00a0V.\n--- --Set the level to be detected on a falling edge.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.analogtrigger.edge.slope", - "dmm.digitize.func", - "dmm.measure.analogtrigger.edge.level" - ] - }, - { - "name": "dmm.digitize.comparator.edge", - "webhelpfile": "41396.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.EDGE_FALLING\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "analog trigger was level trigger (leveltrigger).non-digitize: where is dependent on measure DC current range for min and max values and default is 0used when analog trigger mode set to edgedigitize: where is dependent on active digitize function range for min and max values and default is 0", - "param_info": [ - { - "name": "value", - "description": "dmm.EDGE_RISING or dmm.EDGE_FALLING", - "enum": "dmm.EDGE_RISING nil|dmm.EDGE_FALLING nil", - "type": "dmmdigitizecomparatoredgevalue", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.comparator.edge", - "dmm.digitize.comparator.edge = value" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DCI_DIGITIZER;dmm.digitize.comparator.mode = dmm.MODE_LEVEL;dmm.digitize.comparator.edge = dmm.EDGE_RISING;", - "description": "\u00a0\n" - } - ], - "related_commands": [ - "dmm.digitize.comparator.mode", - "dmm.digitize.func" - ] - }, - { - "name": "dmm.digitize.analogtrigger.window.direction", - "webhelpfile": "41398.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.DIRECTION_ENTER\n", - "tsp_link": "Yes\n", - "description": "This attribute defines if the analog trigger occurs when the signal enters or leaves the defined high and low analog signal level boundaries.", - "details": "This is only available when the analog trigger mode is set to window.", - "param_info": [ - { - "name": "value", - "description": "The direction", - "enum": "dmm.DIRECTION_ENTER nil|dmm.DIRECTION_LEAVE nil", - "type": "dmmdigitizeanalogtriggerwindowdirectionvalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerwindowdirectionfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.window.direction", - "dmm.digitize.analogtrigger.window.direction = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_WINDOW_DIRECTION)", - "dmm.measure.setattribute(function, ATTR_DIGI_WINDOW_DIRECTION, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_WINDOW;dmm.digitize.analogtrigger.window.levelhigh = 5;dmm.digitize.analogtrigger.window.levellow = 1;dmm.digitize.analogtrigger.window.direction = dmm.DIRECTION_LEAVE;", - "description": "Set function to digitize voltage.\n--- --Set the analog trigger mode to window.\n--- --Set the analog trigger high level to 5\u00a0V.\n--- --Set the analog trigger low level to 1\u00a0V.\n--- --Set the trigger to occur when the signal leaves the window.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.analogtrigger.window.levelhigh", - "dmm.digitize.analogtrigger.window.levellow", - "dmm.digitize.func", - "dmm.measure.analogtrigger.window.direction" - ] - }, - { - "name": "dmm.digitize.analogtrigger.pulse.width", - "webhelpfile": "41400.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 ms\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the threshold value for the pulse width.", - "details": "This option is only available when the analog trigger mode is set to pulse.This option sets either the minimum or maximum pulse width that generates an analog trigger event. The value of pulse condition determines whether this value is interpreted as the minimum or maximum pulse width.", - "param_info": [ - { - "name": "value", - "description": "The threshold value for the pulse width", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerpulsewidthfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.pulse.width", - "dmm.digitize.analogtrigger.pulse.width = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_PULSE_WIDTH)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_PULSE_WIDTH, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_PULSE;dmm.digitize.analogtrigger.pulse.level = 5;dmm.digitize.analogtrigger.pulse.width = 30e-6;dmm.digitize.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.digitize.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set function to digitize voltage.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.func", - "dmm.digitize.analogtrigger.pulse.condition", - "dmm.digitize.analogtrigger.pulse.level", - "dmm.digitize.analogtrigger.pulse.polarity", - "dmm.measure.analogtrigger.pulse.width" - ] - }, - { - "name": "dmm.digitize.analogtrigger.pulse.polarity", - "webhelpfile": "41402.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.POLARITY_ABOVE\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the polarity of the pulse that generates an analog trigger event.", - "details": "Only used when analog trigger mode is pulse.Determines if the analog trigger occurs when the pulse is above the defined signal level or below the defined signal level.", - "param_info": [ - { - "name": "value", - "description": "The setting", - "enum": "dmm.POLARITY_ABOVE nil|dmm.POLARITY_BELOW nil", - "type": "dmmdigitizeanalogtriggerpulsepolarityvalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerpulsepolarityfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.pulse.polarity", - "dmm.digitize.analogtrigger.pulse.polarity = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_PULSE_POLARITY)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_PULSE_POLARITY, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_PULSE;dmm.digitize.analogtrigger.pulse.level = 5;dmm.digitize.analogtrigger.pulse.width = 30e-6;dmm.digitize.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.digitize.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set function to digitize voltage.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.func", - "dmm.digitize.analogtrigger.pulse.condition", - "dmm.digitize.analogtrigger.pulse.level", - "dmm.digitize.analogtrigger.pulse.width", - "dmm.measure.analogtrigger.pulse.polarity" - ] - }, - { - "name": "dmm.measure.analogtrigger.pulse.level", - "webhelpfile": "41404.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the pulse level that generates an analog trigger event.", - "details": "Only available when the analog trigger mode is set to pulse.To use the analog trigger with the measure functions, a range must be set (you cannot use autorange) and autozero must be disabled.", - "param_info": [ - { - "name": "value", - "description": "The signal level", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.pulse.level", - "dmm.measure.analogtrigger.pulse.level = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_PULSE_LEVEL)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_PULSE_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.range = 10;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_PULSE;dmm.measure.analogtrigger.pulse.level = 5;dmm.measure.analogtrigger.pulse.width = 30e-6;dmm.measure.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.measure.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set measure function to DC voltage.\n--- --Set range to 10\u00a0V.\n--- --Disable autozero.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.pulse.level", - "dmm.measure.analogtrigger.mode", - "dmm.measure.analogtrigger.pulse.condition", - "dmm.measure.analogtrigger.pulse.polarity", - "dmm.measure.analogtrigger.pulse.width" - ] - }, - { - "name": "dmm.digitize.analogtrigger.window.levelhigh", - "webhelpfile": "41406.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "Digitize current: 5e-6 (5 \u00b5A)Digitize voltage: 0.05 (50 mV)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the upper boundary of the analog trigger window.", - "details": "Only available when the analog trigger mode is set to window.The high level must be greater than the low level.", - "param_info": [ - { - "name": "value", - "description": "The upper boundary of the window", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerwindowlevelhighfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.window.levelhigh", - "dmm.digitize.analogtrigger.window.levelhigh = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_WINDOW_LEVEL_HIGH)", - "dmm.measure.setattribute(function, ATTR_DIGI_WINDOW_LEVEL_HIGH, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_WINDOW;dmm.digitize.analogtrigger.window.levelhigh = 5;dmm.digitize.analogtrigger.window.levellow = 1;dmm.digitize.analogtrigger.window.direction = dmm.DIRECTION_LEAVE;", - "description": "Set function to digitize voltage.\n--- --Set the analog trigger mode to window.\n--- --Set the analog trigger high level to 5\u00a0V.\n--- --Set the analog trigger low level to 1\u00a0V.\n--- --Set the trigger to occur when the signal leaves the window.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.analogtrigger.window.direction", - "dmm.digitize.analogtrigger.window.levellow", - "dmm.digitize.func", - "dmm.measure.analogtrigger.window.levelhigh" - ] - }, - { - "name": "dmm.measure.analogtrigger.edge.level", - "webhelpfile": "41407.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the signal level that generates the analog trigger event for the edge trigger mode.", - "details": "This command is only available when the analog trigger mode is set to edge.The edge level can be set to any value in the active measurement range. See the DMM7510 specifications for more information on the resolution and accuracy of the analog trigger.To use the analog trigger with the measure functions, a range must be set (you cannot use autorange) and autozero must be disabled.", - "param_info": [ - { - "name": "value", - "description": "The signal level that generates the trigger", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.edge.level", - "dmm.measure.analogtrigger.edge.level = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_EDGE_LEVEL)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_EDGE_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.range = 3;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_EDGE;dmm.measure.analogtrigger.edge.level = 2.5;dmm.measure.analogtrigger.edge.slope = dmm.SLOPE_FALLING;", - "description": "Set measure function to DC current.\n--- --Set range to 3\u00a0A.\n--- --Disable autozero.\n--- --Set the analog trigger mode to edge.\n--- --Set the analog trigger level to 2.5\u00a0A.\n--- --Set the level to be detected on a falling edge.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.edge.level", - "dmm.measure.analogtrigger.edge.slope", - "dmm.measure.analogtrigger.mode" - ] - }, - { - "name": "dmm.measure.analogtrigger.edge.slope", - "webhelpfile": "41410.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.SLOPE_RISING\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the slope of the analog trigger edge.", - "details": "This is only available when the analog trigger mode is set to edge.Rising causes an analog trigger event when the analog signal trends from below the analog signal level to above the level.Falling causes an analog trigger event when the signal trends from above to below the level.", - "param_info": [ - { - "name": "value", - "description": "The slope of the analog trigger edge", - "enum": "dmm.SLOPE_RISING nil|dmm.SLOPE_FALLING nil", - "type": "dmmmeasureanalogtriggeredgeslopevalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.edge.slope", - "dmm.measure.analogtrigger.edge.slope = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_EDGE_SLOPE)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_EDGE_SLOPE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.range = 3;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_EDGE;dmm.measure.analogtrigger.edge.level = 2.5;dmm.measure.analogtrigger.edge.slope = dmm.SLOPE_FALLING;", - "description": "Set measure function to DC current.\n--- --Set range to 3\u00a0A.\n--- --Disable autozero.\n--- --Set the analog trigger mode to edge.\n--- --Set the analog trigger level to 2.5\u00a0A.\n--- --Set the level to be detected on a falling edge.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.edge.slope", - "dmm.measure.analogtrigger.edge.level", - "dmm.measure.analogtrigger.mode" - ] - }, - { - "name": "dmm.measure.analogtrigger.pulse.width", - "webhelpfile": "41412.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 ms\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the threshold value for the pulse width.", - "details": "This option is only available when the analog trigger mode is set to pulse.This option sets either the minimum or maximum pulse width that generates an analog trigger event. The value of pulse condition determines whether this value is interpreted as the minimum or maximum pulse width.", - "param_info": [ - { - "name": "value", - "description": "The threshold value for the pulse width", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.pulse.width", - "dmm.measure.analogtrigger.pulse.width = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_PULSE_WIDTH)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_PULSE_WIDTH, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.range = 10;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_PULSE;dmm.measure.analogtrigger.pulse.level = 5;dmm.measure.analogtrigger.pulse.width = 30e-6;dmm.measure.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.measure.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set measure function to DC voltage.\n--- --Set range to 10\u00a0V.\n--- --Disable autozero.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.pulse.width", - "dmm.measure.analogtrigger.mode", - "dmm.measure.analogtrigger.pulse.condition", - "dmm.measure.analogtrigger.pulse.polarity", - "dmm.measure.analogtrigger.pulse.width" - ] - }, - { - "name": "dmm.measure.analogtrigger.pulse.polarity", - "webhelpfile": "41414.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.POLARITY_ABOVE\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the polarity of the pulse that generates an analog trigger event.", - "details": "Only used when analog trigger mode is pulse.Determines if the analog trigger occurs when the pulse is above the defined signal level or below the defined signal level.", - "param_info": [ - { - "name": "value", - "description": "The setting", - "enum": "dmm.POLARITY_ABOVE nil|dmm.POLARITY_BELOW nil", - "type": "dmmmeasureanalogtriggerpulsepolarityvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.pulse.polarity", - "dmm.measure.analogtrigger.pulse.polarity = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_PULSE_POLARITY)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_PULSE_POLARITY, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.range = 10;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_PULSE;dmm.measure.analogtrigger.pulse.level = 5;dmm.measure.analogtrigger.pulse.width = 30e-6;dmm.measure.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.measure.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set measure function to DC voltage.\n--- --Set range to 10\u00a0V.\n--- --Disable autozero.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.pulse.polarity", - "dmm.measure.analogtrigger.mode", - "dmm.measure.analogtrigger.pulse.condition", - "dmm.measure.analogtrigger.pulse.polarity", - "dmm.measure.analogtrigger.pulse.width" - ] - }, - { - "name": "dmm.digitize.analogtrigger.pulse.level", - "webhelpfile": "41416.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the pulse level that generates an analog trigger event.", - "details": "Only available when the analog trigger mode is set to pulse.", - "param_info": [ - { - "name": "value", - "description": "The signal level", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerpulselevelfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.pulse.level", - "dmm.digitize.analogtrigger.pulse.level = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_PULSE_LEVEL)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_PULSE_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_PULSE;dmm.digitize.analogtrigger.pulse.level = 5;dmm.digitize.analogtrigger.pulse.width = 30e-6;dmm.digitize.analogtrigger.pulse.condition = dmm.CONDITION_LESS;dmm.digitize.analogtrigger.pulse.polarity = dmm.POLARITY_BELOW;", - "description": "Set function to digitize voltage.\n--- --Set the analog trigger mode to pulse.\n--- --Set the analog trigger level to 5\u00a0V.\n--- --Set the analog trigger pulse width to 30\u00a0us.\n--- --Set the condition to be detect trigger within the pulse width.\n--- --Set the trigger to occur when the pulse is below the level.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.func", - "dmm.digitize.analogtrigger.pulse.condition", - "dmm.digitize.analogtrigger.pulse.polarity", - "dmm.digitize.analogtrigger.pulse.width", - "dmm.measure.analogtrigger.pulse.level" - ] - }, - { - "name": "dmm.measure.autodelay", - "webhelpfile": "41421.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.DELAY_ON \n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables the automatic delay that occurs before each measurement.", - "details": "When this is enabled, a delay is added after a range or function change to allow the instrument to settle.", - "param_info": [ - { - "name": "value", - "description": "Enable the delay", - "enum": "dmm.DELAY_ON nil|dmm.DELAY_OFF nil", - "type": "dmmmeasureautodelayvalue", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.autodelay", - "dmm.measure.autodelay = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_AUTO_DELAY)", - "dmm.measure.setattribute(function, ATTR_MEAS_AUTO_DELAY, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_RESISTANCE;dmm.measure.autodelay = dmm.DELAY_ON;dmm.measure.count = 10;ReadingBufferOne = buffer.make(1000);dmm.measure.read(ReadingBufferOne);", - "description": "Set the instrument to measure 2-wire ohms.\n--- --Turn automatic delay on.\n--- --Create a buffer named ReadingBufferOne.\n--- --Set the number of measurements to 10.\n--- --Make 10 measurements and store them in the reading buffer.\n" - } - ], - "related_commands": [ - "delay()" - ] - }, - { - "name": "dmm.digitize.func", - "webhelpfile": "41428.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.FUNC_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines which digitize function is active.", - "details": "Set this command to the type of measurement you want to digitize.Reading this command returns the digitize function that is presently active.If a basic (non-digitize) measurement function is selected, this returns dmm.FUNC_NONE. The none setting is automatically made if you select a function with dmm.measure.func or through the options from the front-panel Measure Functions tab.", - "param_info": [ - { - "name": "value", - "description": "The digitize measurement function to make active", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil|dmm.FUNC_NONE nil", - "type": "dmmdigitizefuncvalue", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.func", - "dmm.digitize.func = value" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;", - "description": "Set the measurement function to digitize current.\n" - } - ], - "related_commands": [ - "Digitize functions", - "dmm.measure.func" - ] - }, - { - "name": "dmm.digitize.aperture", - "webhelpfile": "41431.htm", - "signature": "", - "command_return": "time", - "type": "Attribute (RW)", - "default_value": "dmm.APERTURE_AUTO\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the aperture setting for the selected function.", - "details": "The aperture is the actual acquisition time of the instrument on the signal. The aperture can be set to automatic or to a specific value in 1\u00a0\u03bcs intervals. If the value is not specified in microseconds, the value is rounded down to the nearest microsecond resolution. When automatic is selected, the aperture setting is set to the maximum value possible for the selected sample rate.The aperture must be less than the reciprocal of the sample rate. The minimum aperture is 1\u00a0\u03bcs when the maximum sampling rate is 1,000,000 samples per second.Set the sample rate before changing the aperture.The maximum aperture available is 1 divided by the sample rate. The aperture cannot be set to more than this value.", - "param_info": [ - { - "name": "time", - "description": "The time of the aperture in seconds or automatic", - "enum": "dmm.APERTURE_AUTO nil", - "type": "dmmdigitizeaperturetime", - "range": "" - } - ], - "usage": [ - "time = dmm.digitize.aperture", - "dmm.digitize.aperture = time", - "time = dmm.measure.getattribute(function, ATTR_DIGI_APERTURE)", - "dmm.measure.setattribute(function, ATTR_DIGI_APERTURE, time)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.samplerate = 200000;dmm.digitize.aperture = dmm.APERTURE_AUTO;dmm.digitize.count = 1;print(dmm.digitize.read());", - "description": "Set the digitize function to measure current. Set the sample rate to 200,000, with a count of 1, and automatic aperture.\n--- --Make a digitize measurement.\n" - } - ], - "related_commands": [ - "Digitize functions", - "dmm.digitize.func", - "dmm.digitize.samplerate", - "dmm.measure.aperture" - ] - }, - { - "name": "dmm.digitize.samplerate", - "webhelpfile": "41433.htm", - "signature": "", - "command_return": "readings", - "type": "Attribute (RW)", - "default_value": "1,000,000 \n", - "tsp_link": "Yes\n", - "description": "This attribute defines the precise acquisition rate at which the digitizing measurements are made.", - "details": "The sample rate determines how fast the DMM7510 acquires a digitized reading.Set the sample rate before setting the aperture. If the aperture setting is too high for the selected sample rate, it is automatically adjusted to the highest aperture that can be used with the sample rate.", - "param_info": [ - { - "name": "readings", - "description": "The number of readings per second", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizesampleratefunction", - "range": "" - } - ], - "usage": [ - "readings = dmm.digitize.samplerate", - "dmm.digitize.samplerate = readings", - "readings = dmm.measure.getattribute(function, ATTR_DIGI_SAMPLE_RATE)", - "dmm.measure.setattribute(function, ATTR_DIGI_SAMPLE_RATE, readings)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_CURRENT;dmm.digitize.samplerate = 200000;dmm.digitize.aperture = dmm.APERTURE_AUTO;dmm.digitize.count = 1;print(dmm.digitize.read());", - "description": "Set the digitize function to digitize current. Set the sample rate to 200,000, with a count of 1, and automatic aperture.\n--- --Make a digitize measurement.\n" - } - ], - "related_commands": [ - "dmm.digitize.aperture", - "dmm.digitize.count" - ] - }, - { - "name": "dmm.measure.sense.autorange", - "webhelpfile": "41434.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the sense range is set manually or automatically.", - "details": "This selects whether the range for the denominator of the ratio is selected manually or automatically.This command determines how the range is selected.When this command is set to off, you must set the range. If you do not set the range, the instrument remains at the range that was last selected by autorange.When this command is set to on, the instrument automatically goes to the most sensitive range to perform the measurement.If a range is manually selected through the front panel or a remote command, this command is automatically set to off.Autorange selects the best range in which to measure the signal that is applied to the input terminals of the instrument. When autorange is enabled, the range increases at 120 percent of range. The range decreases occur when the reading is <10\u00a0percent of nominal range. For example, if you are on the 1\u00a0V range and autorange is enabled, the instrument autoranges up to the 10\u00a0V range when the measurement exceeds 1.2\u00a0V. It autoranges down to the 100\u00a0mV range when the measurement falls below 1\u00a0V.", - "param_info": [ - { - "name": "value", - "description": "Enable autorange", - "enum": "dmm.ON nil|dmm.OFF nil", - "type": "dmmmeasuresenseautorangevalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.sense.autorange", - "dmm.measure.sense.autorange = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_SENSE_RANGE_AUTO)", - "dmm.measure.setattribute(function, ATTR_MEAS_SENSE_RANGE_AUTO, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DCV_RATIO;dmm.measure.sense.autorange = dmm.OFF;", - "description": "Select the DC voltage ratio function.\n--- --Set the sense range to be set manually.\n" - } - ], - "related_commands": [ - "dmm.measure.sense.range" - ] - }, - { - "name": "dmm.measure.sense.range", - "webhelpfile": "41436.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "10\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the positive full-scale range for the sense measurement.", - "details": "The full-scale input for the reference measurement in the denominator of the ratio. It affects the accuracy of the measurements and the maximum signal that can be measured. Autorange is automatically set to off if a specific value is set.When you assign a range value, the instrument is set on a fixed range that is large enough to measure the assigned value. The instrument selects the best range for measuring the maximum expected value. For example, if you expect a sense reading of approximately 9\u00a0V, set the range to 9 V to select the 10\u00a0V range.This command is primarily intended to eliminate the time that is required by the instrument to select an automatic range.Note that when you select a fixed range, an overflow condition can occur.When you read this setting, you see the positive full-scale value of the sense range that the instrument is presently using.", - "param_info": [ - { - "name": "value", - "description": "Range in volts", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.sense.range", - "dmm.measure.sense.range = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_SENSE_RANGE)", - "dmm.measure.setattribute(function, ATTR_MEAS_SENSE_RANGE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DCV_RATIO;dmm.measure.sense.range = 1;", - "description": "Select the DC voltage ratio function.\n--- --Set the sense range to 1\u00a0V.\n" - } - ], - "related_commands": [ - "Ranges", - "dmm.measure.sense.autorange" - ] - }, - { - "name": "dmm.measure.bias.level", - "webhelpfile": "41438.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0.001 (1 mA)\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the amount of current the instrument sources when it makes measurements.", - "details": "Selects the amount of current that is sourced by the instrument to make measurements.", - "param_info": [ - { - "name": "value", - "description": "Enter the value", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.bias.level", - "dmm.measure.bias.level = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_BIAS_LEVEL)", - "dmm.measure.setattribute(function, ATTR_MEAS_BIAS_LEVEL, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.bias.level = 0.0001;", - "description": "Set a bias level of 100 \u00b5A.\n" - } - ], - "related_commands": [ - "dmm.measure.bias.actual" - ] - }, - { - "name": "trigger.limit.direction", - "webhelpfile": "41442.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "hardware trigger limit commands", - "param_info": [ - { - "name": "value", - "description": "Describe value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = group.attribute", - "group.attribute = value" - ], - "overloads": [], - "examples": [ - { - "example": "group.attribute = 2;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "trigger.limit.EVENT_ID", - "webhelpfile": "41444.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "trigger.limit.EVENT_IDhardware trigger limit commands", - "param_info": [ - { - "name": "value", - "description": "Describe value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = group.attribute", - "group.attribute = value" - ], - "overloads": [], - "examples": [ - { - "example": "group.attribute = 2;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "trigger.limit.value", - "webhelpfile": "41448.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1\n", - "tsp_link": "Yes\n", - "description": "This attribute describes something.", - "details": "trigger.limit.valuehardware trigger limit commands", - "param_info": [ - { - "name": "value", - "description": "Describe value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = group.attribute", - "group.attribute = value" - ], - "overloads": [], - "examples": [ - { - "example": "group.attribute = 2;", - "description": "Describe\n" - } - ], - "related_commands": [ - "Insert hyperlinks here" - ] - }, - { - "name": "dmm.digitize.readwithtime()", - "webhelpfile": "41622.htm", - "signature": "dmm.digitize.readwithtime(bufferName)", - "command_return": "reading, seconds, fractional", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function initiates digitize measurements and returns the last actual measurement and time information in UTC format without using the trigger mode.", - "details": "This command initiates digitize measurements using the present function settings, stores the readings in a reading buffer, and returns the last reading.The dmm.digitize.count attribute determines how many measurements are performed.When you use a reading buffer with a command or action that makes multiple readings, all readings are available in the reading buffer. However, only the last reading is returned as a reading with the command.If you define a specific reading buffer, the reading buffer must exist before you make the measurement.", - "param_info": [ - { - "name": "reading", - "description": "The last reading of the measurement process", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "seconds", - "description": "Seconds in UTC format", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractional", - "description": "Fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; if no buffer is specified, this parameter defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "reading, seconds, fractional = dmm.digitize.readwithtime()", - "reading, seconds, fractional = dmm.digitize.readwithtime(bufferName)" - ], - "overloads": [ - "reading, seconds, fractional = dmm.digitize.readwithtime()" - ], - "examples": [ - { - "example": "print(dmm.digitize.readwithtime(defbuffer1));", - "description": "Print the last digitize measurement and time information from defbuffer1 in UTC format, which will look similar to:\n--- ---0.0003882925875\t1415795836\t0.946164546\n" - } - ], - "related_commands": [ - "dmm.digitize.count", - "dmm.digitize.func", - "trigger.model.load() \u2014 SimpleLoop" - ] - }, - { - "name": "dmm.measure.limit[Y].audible", - "webhelpfile": "41684.htm", - "signature": "", - "command_return": "state", - "type": "Attribute (RW)", - "default_value": "Continuity: dmm.AUDIBLE_PASSOther functions: dmm.AUDIBLE_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument beeper sounds when a limit test passes or fails.", - "details": "The tone and length of beeper cannot be adjusted.See dmm.measure.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "state", - "description": "When the beeper sounds", - "enum": "dmm.AUDIBLE_NONE nil|dmm.AUDIBLE_FAIL nil|dmm.AUDIBLE_PASS nil", - "type": "dmmmeasurelimitaudiblestate", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measure function; see Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "state = dmm.measure.limit[Y].audible", - "dmm.measure.limit[Y].audible = state", - "state = dmm.measure.getattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y)", - "dmm.measure.setattribute(function, ATTR_MEAS_LIMIT_AUDIBLE_Y, state)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.FUNC_DC_VOLTAGE;", - "description": "dmm.FUNC_RESISTANCE\n" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].audible", - "dmm.measure.limit[Y].enable" - ] - }, - { - "name": "dmm.digitize.limit[Y].audible", - "webhelpfile": "41685.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.AUDIBLE_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if the instrument beeper sounds when a limit test passes or fails.", - "details": "The tone and length of beeper cannot be adjusted.See dmm.digitize.limit[Y].low.value for an example of how to use this command.", - "param_info": [ - { - "name": "value", - "description": "When the beeper sounds", - "enum": "dmm.AUDIBLE_NONE nil|dmm.AUDIBLE_FAIL nil|dmm.AUDIBLE_PASS nil", - "type": "dmmdigitizelimitaudiblevalue", - "range": "" - }, - { - "name": "Y", - "description": "Limit number", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizelimitaudiblefunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.limit[Y].audible", - "dmm.digitize.limit[Y].audible = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_LIMIT_AUDIBLE_Y)", - "dmm.measure.setattribute(function, ATTR_DIGI_LIMIT_AUDIBLE_Y, value)" - ], - "overloads": [], - "examples": [ - { - "example": "value;", - "description": "When the beeper sounds:\n--- --Never: dmm.AUDIBLE_NONEOn test failure: dmm.AUDIBLE_FAILOn test pass: dmm.AUDIBL" - } - ], - "related_commands": [ - "dmm.digitize.limit[Y].enable" - ] - }, - { - "name": " trigger.BLOCK_RESET_BRANCH_COUNT", - "webhelpfile": "41689.htm", - "signature": "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)", - "command_return": "", - "type": "Attribute (WO)\n", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function creates a block in the trigger model that resets a branch counter to 0.", - "details": "When the trigger model reaches the Counter Reset block, it resets the count of the specified Branch on Counter block to zero.", - "param_info": [ - { - "name": "blockNumber", - "description": "The sequence of the block in the trigger model", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "counter", - "description": "The block number of the counter that is to be reset", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "trigger.model.setblock(blockNumber, trigger.BLOCK_RESET_BRANCH_COUNT, counter)" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.model.load(\"Empty\");trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR);trigger.model.setblock(2, trigger.BLOCK_MEASURE_DIGITIZE);trigger.model.setblock(3, trigger.BLOCK_BRANCH_COUNTER, 5, 2);trigger.model.setblock(4, trigger.BLOCK_DELAY_CONSTANT, 1);trigger.model.setblock(5, trigger.BLOCK_BRANCH_COUNTER, 3, 2);trigger.model.setblock(6, trigger.BLOCK_RESET_BRANCH_COUNT, 3);trigger.model.initiate();waitcomplete();print(defbuffer1.n);", - "description": "Reset trigger model settings.\n--- --Clear defbuffer1 at the beginning of the trigger model.\n--- --Loop and take 5 readings.\n--- --Delay a second.\n--- --Loop three more times back to block 2.\n--- --Reset block 3 to 0.\n--- --Start the trigger model and wait for measurements to complete.\n--- --Print the number of readings in the buffer.\n--- --Output:\n--- --15\n" - } - ], - "related_commands": [ - "trigger.model.getbranchcount()", - "trigger.model.setblock() \u2014 trigger.BLOCK_BRANCH_COUNTER" - ] - }, - { - "name": "dmm.measure.rel.method", - "webhelpfile": "41691.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.METHOD_PARTS\n", - "tsp_link": "Yes\n", - "description": "This attribute determines if relative offset is applied to the measurements before calculating the DC voltage ratio value.", - "details": "This command determines if relative offset is applied to the voltage measurements before the ratio calculation or if the relative offset is applied to the final calculated value.When the parts method is selected, the individual readings each have the relative offset value applied before being used to calculate the measurement reading. The relative offset value is working with smaller ranges, so an error may occur. Reduce the relative offset value if you receive an error. When a relative offset value is acquired when the parts method is selected, the relative offset levels are made and applied to both input and sense.A relative offset is applied to the sense value and then to the input value.When the results method is selected, the individual readings do not have the relative offset value applied. The relative offset value is applied to the final calculation.", - "param_info": [ - { - "name": "value", - "description": "The method used", - "enum": "dmm.METHOD_RESULT nil|dmm.METHOD_PARTS nil", - "type": "dmmmeasurerelmethodvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.rel.method", - "dmm.measure.rel.method = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_REL_METHOD)", - "dmm.measure.setattribute(function, ATTR_MEAS_REL_METHOD, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DCV_RATIO;dmm.measure.rel.method = dmm.METHOD_PARTS;", - "description": "Set the measure function to DC voltage ratio.\n--- --Set the method to apply relative offset before generating the ratio.\n" - } - ], - "related_commands": [ - "dmm.measure.rel.enable", - "dmm.measure.rel.level", - "Relative offset" - ] - }, - { - "name": "dmm.digitize.analogtrigger.window.levellow", - "webhelpfile": "41724.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the lower boundary of the analog trigger window.", - "details": "Only available when the analog trigger mode is set to window.The low level must be less than the high level.", - "param_info": [ - { - "name": "value", - "description": "The lower boundary of the window", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerwindowlevellowfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.window.levellow", - "dmm.digitize.analogtrigger.window.levellow = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_WINDOW_LEVEL_LOW)", - "dmm.measure.setattribute(function, ATTR_DIGI_WINDOW_LEVEL_LOW, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_WINDOW;dmm.digitize.analogtrigger.window.levelhigh = 5;dmm.digitize.analogtrigger.window.levellow = 1;dmm.digitize.analogtrigger.window.direction = dmm.DIRECTION_LEAVE;", - "description": "Set function to digitize voltage.\n--- --Set the analog trigger mode to window.\n--- --Set the analog trigger high level to 5\u00a0V.\n--- --Set the analog trigger low level to 1\u00a0V.\n--- --Set the trigger to occur when the signal leaves the window.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.analogtrigger.window.direction", - "dmm.digitize.analogtrigger.window.levelhigh", - "dmm.digitize.func", - "dmm.measure.analogtrigger.window.levellow" - ] - }, - { - "name": "dmm.measure.analogtrigger.window.direction", - "webhelpfile": "41727.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.DIRECTION_ENTER\n", - "tsp_link": "Yes\n", - "description": "This attribute defines if the analog trigger occurs when the signal enters or leaves the defined high and low analog signal level boundaries.", - "details": "This is only available when the analog trigger mode is set to window.", - "param_info": [ - { - "name": "value", - "description": "The direction", - "enum": "dmm.DIRECTION_ENTER nil|dmm.DIRECTION_LEAVE nil", - "type": "dmmmeasureanalogtriggerwindowdirectionvalue", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.window.direction", - "dmm.measure.analogtrigger.window.direction = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_WINDOW_DIRECTION)", - "dmm.measure.setattribute(function, ATTR_MEAS_WINDOW_DIRECTION, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.range = 10;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_WINDOW;dmm.measure.analogtrigger.window.levelhigh = 5;dmm.measure.analogtrigger.window.levellow = 1;dmm.measure.analogtrigger.window.direction = dmm.DIRECTION_LEAVE;", - "description": "Set measure function to DC voltage.\n--- --Set range to 10\u00a0V.\n--- --Disable autozero.\n--- --Set the analog trigger mode to window.\n--- --Set the analog trigger high level to 5\u00a0V.\n--- --Set the analog trigger low level to 1\u00a0V.\n--- --Set the trigger to occur when the signal leaves the window.\n" - } - ], - "related_commands": [ - "dmm.digitize.analogtrigger.window.direction", - "dmm.measure.analogtrigger.mode", - "dmm.measure.analogtrigger.window.levelhigh", - "dmm.measure.analogtrigger.window.levellow" - ] - }, - { - "name": "dmm.digitize.coupling.acfilter", - "webhelpfile": "41743.htm", - "signature": "", - "command_return": "type", - "type": "Attribute (RW)", - "default_value": "dmm.AC_FILTER_SLOW\n", - "tsp_link": "Yes\n", - "description": "This attribute selects the instrument settling time when coupling is set to AC.", - "details": "This option is only used when digitize signal coupling is set to AC.When the signal coupling is set to AC, there may still be some DC signal content that comes in with the AC signal. To allow this signal to settle out, you can set AC coupling filter to slow. When the filter is set to slow, the instrument adds an 800\u00a0ms delay before making measurements.When the AC coupling filter is set to fast, the instrument adds an 80\u00a0ms delay before making measurements. Set the AC filter to fast for faster settling when measuring rapidly changing inputs. For most digitize voltage measurements, the 80\u00a0ms delay is enough time for the range to settle.", - "param_info": [ - { - "name": "type", - "description": "Type of AC coupling filter", - "enum": "dmm.AC_FILTER_SLOW nil|dmm.AC_FILTER_FAST nil", - "type": "dmmdigitizecouplingacfiltertype", - "range": "" - } - ], - "usage": [ - "type = dmm.digitize.coupling.acfilter", - "dmm.digitize.coupling.acfilter = type", - "type = dmm.measure.getattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_COUPLING_AC_FILTER)", - "dmm.measure.setattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_COUPLING_AC_FILTER, type)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.coupling.type = dmm.COUPLING_AC;dmm.digitize.coupling.acfilter = dmm.AC_FILTER_FAST;", - "description": "Set the measure function to digitize voltage.\n--- --Set the coupling type to AC.\n--- --Set the filter to fast.\n" - } - ], - "related_commands": [ - "DC and AC coupling", - "dmm.digitize.coupling.acfrequency", - "dmm.digitize.coupling.type" - ] - }, - { - "name": "dmm.digitize.coupling.acfrequency", - "webhelpfile": "41744.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1000\n", - "tsp_link": "Yes\n", - "description": "This attribute allows you to optimize the amplitude to compensate for signal loss across the coupling capacitor when AC coupling is selected.", - "details": "This command is only used when the digitize coupling type is set to AC.For example, if you are measuring a 50\u00a0Hz signal, you could set this to 50\u00a0Hz to compensate for voltage drop across the coupling capacitor.", - "param_info": [ - { - "name": "value", - "description": "The frequency", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.coupling.acfrequency", - "dmm.digitize.coupling.acfrequency = value", - "value = dmm.measure.getattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_COUPLING_AC_FREQUENCY)", - "dmm.measure.setattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_COUPLING_AC_FREQUENCY, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.coupling.type = dmm.COUPLING_AC;dmm.digitize.coupling.acfrequency = 50;", - "description": "Set the digitize function to voltage.\n--- --Set the coupling type to AC.\n--- --Set the frequency to 500 Hz.\n" - } - ], - "related_commands": [ - "dmm.digitize.coupling.acfilter", - "dmm.digitize.coupling.type" - ] - }, - { - "name": "acal.count", - "webhelpfile": "43634.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the number of times autocalibration has been run.", - "details": "The number of times that autocalibration has been run since the last factory calibration. The count restarts at 1 after a factory calibration.", - "param_info": [ - { - "name": "value", - "description": "The number of times autocalibration has been run", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = acal.count" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.count);", - "description": "Returns the number of times autocalibration has been run.\n--- --Example output:\n--- --15\n" - } - ], - "related_commands": [ - "acal.run()" - ] - }, - { - "name": "acal.lastrun.internaltemp", - "webhelpfile": "43635.htm", - "signature": "", - "command_return": "temperature", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the internal temperature of the instrument when autocalibration was run.", - "details": "The temperature is displayed in Celsius (\u00b0C).The instrument updates the internal temperature value when the instrument refreshes autozero. If autozero is set to off or if autozero is not available for the selected function (such as capacitance, continuity, frequency, or period), the internal temperature value is not updated.", - "param_info": [ - { - "name": "temperature", - "description": "The internal temperature", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "temperature = acal.lastrun.internaltemp" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.lastrun.internaltemp);", - "description": "Returns the internal temperature of the instrument when autocalibration was last run.\n--- --Example output:\n--- --63.167084\n" - } - ], - "related_commands": [ - "acal.lastrun.tempdiff", - "acal.run()" - ] - }, - { - "name": "acal.lastrun.time", - "webhelpfile": "43636.htm", - "signature": "", - "command_return": "dateTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the date and time when autocalibration was last run.", - "details": "The date and time is returned in the format:MM/DD/YYYY HH:MM:SS.NNNNNNNNNWhere:", - "param_info": [ - { - "name": "dateTime", - "description": "The date and time", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dateTime = acal.lastrun.time" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.lastrun.time);", - "description": "Returns the date and time when the autocalibration was last run.\n--- --Example output:\n--- --08/11/2014 16:30:26.745369595\n" - } - ], - "related_commands": [ - "acal.run()" - ] - }, - { - "name": "acal.nextrun.time", - "webhelpfile": "43637.htm", - "signature": "", - "command_return": "dateTime", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the date and time when the next autocalibration is scheduled to be run.", - "details": "The date and time is returned in the format:MM/DD/YYYY HH:MM:SS.NNNNNNNNNWhere:", - "param_info": [ - { - "name": "dateTime", - "description": "The date and time when autocalibration is scheduled to be run", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dateTime = acal.nextrun.time" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.nextrun.time);", - "description": "Returns date and time when autocalibration is next scheduled to be run.\n--- --Example output:\n--- --05/29/2014 17:11:17.000000000\n" - } - ], - "related_commands": [ - "Autocalibration", - "acal.run()", - "acal.schedule()" - ] - }, - { - "name": "acal.schedule()", - "webhelpfile": "43638.htm", - "signature": "acal.schedule(action, interval, hour)", - "command_return": "", - "type": "Function", - "default_value": "Run every 8 hours starting at midnight\n", - "tsp_link": "Yes\n", - "description": "This function sets how often autocalibration occurs or prompts you to run it.", - "details": "When autocalibration is scheduled to run at a scheduled interval, but it runs at a time other than the scheduled interval, subsequent scheduled intervals are adjusted according to the actual autocalibration start time.", - "param_info": [ - { - "name": "action", - "description": "Determines when and if the instrument automatically runs autocalibration", - "enum": "acal.ACTION_RUN nil|acal.ACTION_NOTIFY nil|acal.ACTION_NONE nil", - "type": "acalscheduleaction", - "range": "" - }, - { - "name": "interval", - "description": "Determines how often autocalibration should be run or notification should occur", - "enum": "acal.INTERVAL_8HR nil|acal.INTERVAL_16HR nil|acal.INTERVAL_1DAY nil|acal.INTERVAL_7DAY nil|acal.INTERVAL_14DAY nil|acal.INTERVAL_30DAY nil|acal.INTERVAL_90DAY nil", - "type": "acalscheduleinterval", - "range": "" - }, - { - "name": "hour", - "description": "Specify when the autocalibration should occur; specify in 24-hour time format (0 to 23; default is 0); not available for the 8-hour or 16-hour interval", - "enum": "", - "type": "integer", - "range": "(0 to 23; default is 0)" - } - ], - "usage": [ - "acal.schedule()", - "acal.schedule(action)", - "acal.schedule(action, interval)", - "acal.schedule(action, interval, hour)" - ], - "overloads": [ - "acal.schedule()", - "acal.schedule(action)", - "acal.schedule(action, interval)" - ], - "examples": [ - { - "example": "acal.schedule(acal.ACTION_RUN, acal.INTERVAL_1DAY, 8);", - "description": "Sets autocalibration to run every day at 8\u00a0am.\n" - } - ], - "related_commands": [ - "Autocalibration", - "acal.run()" - ] - }, - { - "name": "acal.revert()", - "webhelpfile": "43639.htm", - "signature": "acal.revert()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns autocalibration constants to the previous constants.", - "details": "This command reverts the present set of autocalibration constants to the previous set of autocalibration constants.The last run time and internal temperature are reverted to the previous values. The autocalibration count is reset to 1.", - "param_info": [ - { - "name": "acal.revert()", - "description": "Autocalibration values are reverted to the previous set of autocalibration constants.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "acal.revert()" - ], - "overloads": [], - "examples": [ - { - "example": "acal.revert();", - "description": "Autocalibration values are reverted to the previous set of autocalibration constants.\n" - } - ], - "related_commands": [ - "acal.run()" - ] - }, - { - "name": "acal.run()", - "webhelpfile": "43640.htm", - "signature": "acal.run()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function immediately runs autocalibration and stores the constants.", - "details": "During autocalibration, a progress message is displayed on the front panel, all necessary autocalibration steps are completed, calibration constants are updated, and autocalibration last run information is updated. At completion, an event message is generated.If you have set up autocalibration to run at a scheduled interval, when you send the run command, the instrument adjusts the next scheduled autocalibration to be the next interval. For example, if autocalibration is scheduled to run every 7 days, but you run autocalibration on day 3, the next autocalibration will run 7 days after day 3.When an autocalibration command is received, the instrument runs the autocalibration to completion before executing the next command.", - "param_info": [ - { - "name": "acal.run()", - "description": "Autocalibration starts running. When it is complete, an information message is generated in the event log.", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "acal.run()" - ], - "overloads": [], - "examples": [ - { - "example": "acal.run();", - "description": "Autocalibration starts running. When it is complete, an information message is generated in the event log.\n" - } - ], - "related_commands": [ - "acal.schedule()", - "None", - "localnode.internaltemp" - ] - }, - { - "name": "dmm.digitize.analogtrigger.edge.slope", - "webhelpfile": "43708.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.SLOPE_RISING\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the slope of the analog trigger edge.", - "details": "This is only available when the analog trigger mode is set to edge.Rising causes an analog trigger event when the analog signal trends from below the analog signal level to above the level.Falling causes an analog trigger event when the signal trends from above to below the level.", - "param_info": [ - { - "name": "value", - "description": "The slope of the analog trigger edge", - "enum": "dmm.SLOPE_RISING nil|dmm.SLOPE_FALLING nil", - "type": "dmmdigitizeanalogtriggeredgeslopevalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggeredgeslopefunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.analogtrigger.slope", - "dmm.digitize.analogtrigger.slope = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_EDGE_SLOPE)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_EDGE_SLOPE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_EDGE;dmm.digitize.analogtrigger.edge.level = 5;dmm.digitize.analogtrigger.edge.slope = dmm.SLOPE_FALLING;", - "description": "Set the function to digitize voltage.\n--- --Set the analog trigger mode to edge.\n--- --Set the level to sense 5\u00a0V.\n--- --Set the level to be detected on a falling edge.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.edge.level", - "dmm.digitize.analogtrigger.mode", - "dmm.digitize.func", - "dmm.measure.analogtrigger.edge.slope" - ] - }, - { - "name": "dmm.measure.analogtrigger.window.levelhigh", - "webhelpfile": "43709.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "DC current: 5 \u00b5ADC voltage: 50 mV\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the upper boundary of the analog trigger window.", - "details": "Only available when the analog trigger mode is set to window.The high level must be greater than the low level.To use the analog trigger with the measure functions, a range must be set (you cannot use autorange) and autozero must be disabled.", - "param_info": [ - { - "name": "value", - "description": "The upper boundary of the window", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.window.levelhigh", - "dmm.measure.analogtrigger.window.levelhigh = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_WINDOW_LEVEL_HIGH)", - "dmm.measure.setattribute(function, ATTR_MEAS_WINDOW_LEVEL_HIGH, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.range = 10;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_WINDOW;dmm.measure.analogtrigger.window.levelhigh = 5;dmm.measure.analogtrigger.window.levellow = 1;dmm.measure.analogtrigger.window.direction = dmm.DIRECTION_LEAVE;", - "description": "Set measure function to DC voltage.\n--- --Set range to 10\u00a0V.\n--- --Disable autozero.\n--- --Set the analog trigger mode to window.\n--- --Set the analog trigger high level to 5\u00a0V.\n--- --Set the analog trigger low level to 1\u00a0V.\n--- --Set the trigger to occur when the signal leaves the window.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.window.levelhigh", - "dmm.measure.analogtrigger.mode", - "dmm.measure.analogtrigger.window.direction", - "dmm.measure.analogtrigger.window.levellow" - ] - }, - { - "name": "dmm.measure.analogtrigger.window.levellow", - "webhelpfile": "43710.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "0\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the lower boundary of the analog trigger window.", - "details": "Only available when the analog trigger mode is set to window.The high level must be greater than the low level.To use the analog trigger with the measure functions, a range must be set (you cannot use autorange) and autozero must be disabled.", - "param_info": [ - { - "name": "value", - "description": "The lower boundary of the window", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.analogtrigger.window.levellow", - "dmm.measure.analogtrigger.window.levellow = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_WINDOW_LEVEL_LOW)", - "dmm.measure.setattribute(function, ATTR_DIGI_WINDOW_LEVEL_LOW, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.range = 10;dmm.measure.autozero.enable = dmm.OFF;dmm.measure.analogtrigger.mode = dmm.MODE_WINDOW;dmm.measure.analogtrigger.window.levelhigh = 5;dmm.measure.analogtrigger.window.levellow = 1;dmm.measure.analogtrigger.window.direction = dmm.DIRECTION_LEAVE;", - "description": "Set measure function to DC voltage.\n--- --Set range to 10\u00a0V.\n--- --Disable autozero.\n--- --Set the analog trigger mode to window.\n--- --Set the analog trigger high level to 5\u00a0V.\n--- --Set the analog trigger low level to 1\u00a0V.\n--- --Set the trigger to occur when the signal leaves the window.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.window.levellow", - "dmm.measure.analogtrigger.mode", - "dmm.measure.analogtrigger.window.direction", - "dmm.measure.analogtrigger.window.levelhigh" - ] - }, - { - "name": "dmm.digitize.unit", - "webhelpfile": "43717.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "dmm.UNIT_VOLT (digitize voltage function)dmm.UNIT_AMP (digitize current function)\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.", - "details": "The change in measurement units is displayed when the next measurement is made. You can only change the units for the listed functions.", - "param_info": [ - { - "name": "value", - "description": "Units to display for the digitize voltage function", - "enum": "dmm.UNIT_VOLT nil|dmm.UNIT_DB nil|dmm.UNIT_DBM nil|dmm.UNIT_AMP nil", - "type": "dmmdigitizeunitvalue", - "range": "" - }, - { - "name": "function", - "description": "The digitize function", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeunitfunction", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.unit", - "dmm.digitize.unit = value", - "value = dmm.measure.getattribute(function, ATTR_DIGI_UNIT)", - "dmm.measure.setattribute(function, ATTR_DIGI_UNIT, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.unit = dmm.UNIT_DB;", - "description": "Set the measure function to digitize voltage.\n--- --Set the units to display in decibels.\n" - } - ], - "related_commands": [ - "dmm.digitize.dbreference", - "dmm.digitize.func", - "Show voltage readings in decibels", - "Show voltage readings in decibel-milliwatts (dBm)" - ] - }, - { - "name": "localnode.internaltemp", - "webhelpfile": "43771.htm", - "signature": "", - "command_return": "temperature", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the internal temperature of the instrument.", - "details": "Returns the last recorded value of internal temperature of the instrument in Celsius (\u00b0C). The instrument checks internal temperature when it updates references when autozero is on. Internal temperature is not checked if autozero is set to off. It can also become stale when digitize measurements are used or when measurements take a long time.If the temperature changes more than \u00b15\u00a0\u00b0C, the instrument logs an event and displays a message on the front panel that recommends that you perform autocalibration.", - "param_info": [ - { - "name": "temperature", - "description": "The internal temperature of the instrument", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "temperature = localnode.internaltemp" - ], - "overloads": [], - "examples": [ - { - "example": "print(localnode.internaltemp);", - "description": "Returns the internal temperature of the instrument.\n--- --Example output:\n--- --53.732574528\n" - } - ], - "related_commands": [ - "acal.lastrun.internaltemp", - "acal.run()" - ] - }, - { - "name": "dmm.trigger.measure.stimulus", - "webhelpfile": "44068.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "dmm.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the instrument to make a measurement the next time it detects the specified trigger event.", - "details": "This command is intended to provide the lowest possible latency between an event such as digital I/O and a reading. It forces the instrument to make a measurement the next time it detects the specified trigger event. Options for the trigger event parameter are listed in the following table.A measure function must be active before sending this command. The measurement is made for the active measure function. If a digitize function is active, an error is generated.Before using this command, set the active reading buffer. Readings are stored in the active reading buffer.If the count is set to more than 1, the first reading is initialized by this trigger. Subsequent readings occur as rapidly as the instrument can make them. If a trigger occurs during the group measurement, the trigger is latched and another group of measurements with the same count will be triggered after the current group completes. If the stimulus is set to none, this command has no effect on readings.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "event = dmm.trigger.measure.stimulus", - "dmm.trigger.measure.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "reset();dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.trigger.measure.stimulus = trigger.EVENT_DISPLAY;dmm.measure.count = 10;", - "description": "Reset the instrument.\n--- --Set the function to DC current.\n--- --Set the trigger stimulus to be the front-panel TRIGGER key.\n--- --Set the count to 10.\n--- --Press the TRIGGER key to generate 10 readings that are stored in the active reading buffer.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dmm.trigger.digitize.stimulus", - "webhelpfile": "44069.htm", - "signature": "", - "command_return": "event", - "type": "Attribute (RW)", - "default_value": "dmm.EVENT_NONE\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the instrument to digitize a measurement the next time it detects the specified trigger event.", - "details": "This command is intended to provide the lowest possible latency between a trigger event such as digital I/O and a reading. It forces the instrument to make a digitize measurement the next time it detects the specified trigger event. Options for the trigger event parameter are listed in the following table.A digitize function must be active before sending this command. The measurement is digitized for the active function. If a measure function is active, an error is generated.Before using this command, set the active reading buffer. Readings are stored in the active reading buffer.If the count is set to more than 1, the first reading is initialized by this trigger. Subsequent readings occur as rapidly as the instrument can make them. If a trigger occurs during the group measurement, the trigger is latched and another group of measurements with the same count will be triggered after the current group completes.If the stimulus is set to none, this command has no effect on readings.", - "param_info": [ - { - "name": "event", - "description": "The event to use as a stimulus; see Details", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "event = dmm.trigger.digitize.stimulus", - "dmm.trigger.digitize.stimulus = event" - ], - "overloads": [], - "examples": [ - { - "example": "reset();dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.analogtrigger.mode = dmm.MODE_EDGE;dmm.digitize.analogtrigger.edge.slope = dmm.SLOPE_RISING;dmm.digitize.analogtrigger.edge.level = 0.5;dmm.trigger.digitize.stimulus = trigger.EVENT_ANALOGTRIGGER;", - "description": "Reset the instrument.\n--- --Set the function to digitize voltage.\n--- --Set the analog trigger mode to edge.\n--- --Set the slope to rising.\n--- --Set the level to 0.5 V.\n--- --Set the stimulus to be the analog trigger.\n" - } - ], - "related_commands": [ - "dmm.digitize.count", - "dmm.digitize.func" - ] - }, - { - "name": "dmm.measure.analogtrigger.highfreqreject", - "webhelpfile": "44464.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "dmm.ON\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high frequency rejection on analog trigger events.", - "details": "False triggering around the set analog trigger level may occur with low frequency signals that are noisy, DC, or have low amplitude and slew rate during the peaks of input sine waves less than 250\u00a0Hz. High-frequency rejection avoids false triggers by requiring the trigger event to be sustained for at least 64\u00a0\u03bcs. This behavior is similar to a low pass filter effect with a 4\u00a0kHz 3\u00a0dB bandwidth.When high frequency rejection is on, 64\u00a0\u03bcs of additional trigger latency is incurred. You may also need to adjust the trigger levels to ensure that the trigger condition is satisfied for at least 64\u00a0\u03bcs.", - "param_info": [ - { - "name": "setting", - "description": "0 \u00b5s", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmmeasureanalogtriggerhighfreqrejectsetting", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "setting = dmm.measure.analogtrigger.highfreqreject", - "dmm.measure.analogtrigger.highfreqreject = setting", - "setting = dmm.measure.getattribute(function, ATTR_MEAS_ATRIG_HFREJECT)", - "dmm.measure.setattribute(function, ATTR_MEAS_ATRIG_HFREJECT, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.analogtrigger.highfreqreject = dmm.ON;", - "description": "Set the measure function to DC voltage and turn high frequency rejection for the analog trigger to on.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.digitize.analogtrigger.highfreqreject" - ] - }, - { - "name": "dmm.digitize.analogtrigger.highfreqreject", - "webhelpfile": "44466.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "dmm.OFF\n", - "tsp_link": "Yes\n", - "description": "This attribute enables or disables high frequency rejection on analog trigger events.", - "details": "False triggering around the set analog trigger level may occur with low frequency signals that are noisy, DC, or have low amplitude and slew rate during the peaks of input sine waves less than 250\u00a0Hz. High-frequency rejection avoids false triggers by requiring the trigger event to be sustained for at least 64\u00a0\u03bcs. This behavior is similar to a low pass filter effect with a 4\u00a0kHz 3\u00a0dB bandwidth.When high frequency rejection is on, 64\u00a0\u03bcs of additional trigger latency is incurred. You may also need to adjust the trigger levels to ensure that the trigger condition is satisfied for at least 64\u00a0\u03bcs.", - "param_info": [ - { - "name": "setting", - "description": "0 \u00b5s", - "enum": "dmm.OFF nil|dmm.ON nil", - "type": "dmmdigitizeanalogtriggerhighfreqrejectsetting", - "range": "" - }, - { - "name": "function", - "description": "The digitize function to which to assign this parameter", - "enum": "dmm.FUNC_DIGITIZE_CURRENT nil|dmm.FUNC_DIGITIZE_VOLTAGE nil", - "type": "dmmdigitizeanalogtriggerhighfreqrejectfunction", - "range": "" - } - ], - "usage": [ - "setting = dmm.digitize.analogtrigger.highfreqreject", - "dmm.digitize.analogtrigger.highfreqreject = setting", - "setting = dmm.measure.getattribute(function, ATTR_DIGI_ATRIG_HFREJECT)", - "dmm.measure.setattribute(function, ATTR_DIGI_ATRIG_HFREJECT, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DC_VOLTAGE;dmm.digitize.analogtrigger.highfreqreject = dmm.ON;", - "description": "Set the measure function to DC voltage and turn high frequency rejection for the analog trigger to on.\n" - } - ], - "related_commands": [ - "Analog triggering overview", - "dmm.measure.analogtrigger.highfreqreject" - ] - }, - { - "name": "dmm.measure.inputimpedance", - "webhelpfile": "44539.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "dmm.IMPEDANCE_10M\n", - "tsp_link": "Yes\n", - "description": "This attribute determines when the 10\u00a0M\u03a9 input divider is enabled.", - "details": "Choosing automatic input impedance is a balance between achieving low DC voltage noise on the 100\u00a0mV and 1\u00a0V ranges and optimizing measurement noise due to charge injection. The DMM7510 is optimized for low noise and charge injection when the DUT has less than 100\u00a0k\u03a9 input resistance. When the DUT input impedance is more than 100\u00a0k\u03a9, selecting an input impedance of 10\u00a0M\u03a9 optimizes the measurement for lowest noise on the 100\u00a0mV and 1\u00a0V ranges. You can achieve short-term low noise and low charge injection on the 100\u00a0mV and 1\u00a0V ranges with autozero off. For the 10\u00a0V to 1000\u00a0V ranges, both input impedance settings achieve low charge injection.", - "param_info": [ - { - "name": "setting", - "description": "10\u00a0M\u03a9 for all ranges", - "enum": "dmm.IMPEDANCE_10M nil|dmm.IMPEDANCE_AUTO nil", - "type": "dmmmeasureinputimpedancesetting", - "range": "" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "setting = dmm.measure.inputimpedance", - "dmm.measure.inputimpedance = setting", - "setting = dmm.measure.getattribute(function, ATTR_MEAS_INPUT_IMPEDANCE)", - "dmm.measure.setattribute(function, ATTR_MEAS_INPUT_IMPEDANCE, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.inputimpedance = dmm.IMPEDANCE_AUTO;", - "description": "Set input impedance to be set automatically when the DC voltage function is selected.\n" - } - ], - "related_commands": [ - "dmm.digitize.inputimpedance", - "dmm.measure.opendetector" - ] - }, - { - "name": "dmm.digitize.inputimpedance", - "webhelpfile": "44541.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "dmm.IMPEDANCE_10M\n", - "tsp_link": "Yes\n", - "description": "This attribute determines when the 10\u00a0M\u03a9 input divider is enabled.", - "details": "Choosing automatic input impedance is a balance between achieving low DC voltage noise on the 100\u00a0mV and 1\u00a0V ranges and optimizing measurement noise due to charge injection. The DMM7510 is optimized for low noise and charge injection when the DUT has less than 100\u00a0k\u03a9 input resistance. When the DUT input impedance is more than 100\u00a0k\u03a9, selecting an input impedance of 10\u00a0M\u03a9 optimizes the measurement for lowest noise on the 100\u00a0mV and 1\u00a0V ranges. You can achieve short-term low noise and low charge injection on the 100\u00a0mV and 1\u00a0V ranges with autozero off. For the 10\u00a0V to 1000\u00a0V ranges, both input impedance settings achieve low charge injection.The input impedance setting is only available when coupling is set to DC.", - "param_info": [ - { - "name": "setting", - "description": "10\u00a0M\u03a9 for all ranges", - "enum": "dmm.IMPEDANCE_10M nil|dmm.IMPEDANCE_AUTO nil", - "type": "dmmdigitizeinputimpedancesetting", - "range": "" - } - ], - "usage": [ - "setting = dmm.digitize.inputimpedance", - "dmm.digitize.inputimpedance = setting", - "setting = dmm.measure.getattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_INPUT_IMPEDANCE)", - "dmm.measure.setattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_INPUT_IMPEDANCE, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.inputimpedance = dmm.IMPEDANCE_AUTO;", - "description": "Set input impedance to be set automatically when the digitize voltage function is selected.\n" - } - ], - "related_commands": [ - "dmm.digitize.coupling.type", - "dmm.measure.inputimpedance" - ] - }, - { - "name": "trigger.model.load() - SimpleLoop", - "webhelpfile": "46034.htm", - "signature": "trigger.model.load(SimpleLoop, count, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes a specific number of measurements.", - "details": "This command sets up a loop that sets a delay, makes a measurement, and then repeats the loop the number of times you define in the Count parameter.The out line of the EXT TRIG IN/OUT rear-panel terminal is asserted at the end of each measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger-model blocks in a list format.", - "param_info": [ - { - "name": "SimpleLoop", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "count", - "description": "The number of measurements the instrument will make", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "Indicates the reading buffer to use; the default buffers (defbuffer1 or defbuffer2) or the name of a user-defined buffer; if no buffer is specified, defbuffer1 is used", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)", - "trigger.model.load(SimpleLoop, count, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(SimpleLoop, count)", - "trigger.model.load(SimpleLoop, count, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;dmm.measure.func = dmm.FUNC_DC_CURRENT;dmm.measure.autorange = dmm.ON;dmm.measure.nplc = 1; ;-- Initiate readings;trigger.model.load(\"SimpleLoop\", 200);trigger.model.initiate();waitcomplete();\u00a0;-- Parse index and data into three columns;print(\"Rdg #\", \"Time (s)\", \"Current (A)\");for i = 1, defbuffer1.n do;\u00a0\u00a0\u00a0\u00a0\u00a0 print(i, defbuffer1.relativetimestamps[i], defbuffer1[i]);end;", - "description": "This example uses the SimpleLoop trigger-model template to do a capacitor test. This example produces 200 readings that have output similar to the following example:\n--- --Rdg # Time (s) Current (A)\n--- --1 0 -5.6898339156e-10\n--- --2 0.022129046 -5.6432783106e-10\n--- --3 0.063973966 -5.6329326206e-10\n--- --. . .\n--- --198 5.133657681 -5.5518916972e-10\n--- --199 5.155784187 -5.6363814801e-10\n--- --200 5.177910874 -5.6070686983e-10\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - LoopUntilEvent", - "webhelpfile": "46040.htm", - "signature": "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that makes continuous measurements until the specified event occurs.", - "details": "The event constant is the event that ends infinite triggering or ends readings set to occur before the trigger and start post-trigger readings. The trigger model makes readings until it detects the event constant. After the event, it makes a finite number of readings, based on the setting of the trigger position.The position marks the location in the reading buffer where the trigger will occur. The position is set as a percentage of the buffer capacity. The buffer captures measurements until a trigger occurs. When the trigger occurs, the buffer retains the percentage of readings specified by the position, then captures remaining readings until 100\u00a0percent of the buffer is filled. For example, if this is set to 75 for a reading buffer that holds 10,000 readings, the trigger model makes 2500 readings after it detects the source event. There are 7500 pre-trigger readings and 2500 post-trigger readings.The instrument makes two sets of readings. The first set is made until the trigger event occurs. The second set is made after the trigger event occurs, up to the number of readings calculated by the position parameter.You cannot have the event constant set at none when you run this trigger-model template.The out line of the EXT TRIG IN/OUT rear-panel terminal is asserted at the end of each measurement.The following table lists the options that are available for triggerEvent.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.The following usage has been deprecated; replace it with the usage above that includes the clear parameter.trigger.model.load(\"LoopUntilEvent\", triggerEvent, position)trigger.model.load(\"LoopUntilEvent\", triggerEvent, position, delay)trigger.model.load(\"LoopUntilEvent\", triggerEvent, position, delay, bufferName)trigger.model.load(\"LoopUntilEvent\", triggerEvent, position, delay, bufferName, readingBlock)", - "param_info": [ - { - "name": "LoopUntilEvent", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "triggerEvent", - "description": "The event that ends infinite triggering or readings set to occur before the trigger; see Details", - "enum": "", - "type": "triggerEventsForFunctionParam", - "range": "" - }, - { - "name": "position", - "description": "The number of readings to make in relation to the size of the reading buffer; enter as a percentage (0% to 100%)", - "enum": "", - "type": "number", - "range": "(0% to 100%)" - }, - { - "name": "clear", - "description": "To clear previously detected trigger events when entering the wait block (default)", - "enum": "trigger.CLEAR_ENTER nil|trigger.CLEAR_NEVER nil", - "type": "triggermodelloadLoopUntilEventclear", - "range": "(default)" - }, - { - "name": "delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay, bufferName)" - ], - "overloads": [ - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear)", - "trigger.model.load(LoopUntilEvent, triggerEvent, position, clear, delay)" - ], - "examples": [ - { - "example": "reset(); ;-- Set up measure function;dmm.measure.func = dmm.FUNC_DC_CURRENT; ;-- Initiate readings;trigger.model.load(\"LoopUntilEvent\", trigger.EVENT_DISPLAY, 50);trigger.model.initiate();", - "description": "Reset the instrument.\n--- --Set the instrument to measure current.\n--- --Load the LoopUntilEvent trigger model to make measurements until the front panel trigger key is pressed, then continue to make measurements equal to 50% of the reading buffer size.\n--- --Start the trigger model.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - GradeBinning", - "webhelpfile": "46058.htm", - "signature": "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a grading operation.", - "details": "This trigger-model template allows you to grade components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the pass pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.The out line of the EXT TRIG IN/OUT rear-panel terminal is asserted at the end of each measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.For a detailed example, see the DMM7510 User's Manual section \u201cGrading and binning resistors.\u201d", - "param_info": [ - { - "name": "GradeBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6, or 7 for external in; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 1; range 1 to 15; default is\u00a01", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 2; range 1 to 15; default is\u00a02", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 3; range 1 to 15; default is\u00a04", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement fails limit 4; range 1 to 15; default is\u00a08", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have passed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(GradeBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [ - { - "example": "components;", - "description": "The number of components to measure (1 to 268,435,455)\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - SortBinning", - "webhelpfile": "46066.htm", - "signature": "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that sets up a sorting operation.", - "details": "This trigger-model template allows you to sort components and place them into up to four bins, based on the comparison to limits.To set a limit as unused, set the high value for the limit to be less than the low limit.All limit patterns and the all fail pattern are sent on digital I/O lines 1 to 4, where 1 is the least significant bit.The out line of the EXT TRIG IN/OUT rear-panel terminal is asserted at the end of each measurement.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.For a detailed example, see the section in the Model DMM7510 User\u2019s Manual named \u201cGrading and binning resistors.\u201d", - "param_info": [ - { - "name": "SortBinning", - "description": "load function constant param", - "enum": "", - "type": "loadFunConstParam", - "range": "" - }, - { - "name": "components", - "description": "The number of components to measure (1 to 268,435,455)", - "enum": "", - "type": "number", - "range": "(1 to 268,435,455)" - }, - { - "name": "limitxHigh", - "description": "x is limit 1, 2, 3, or 4; the upper limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limitxLow", - "description": "x is 1, 2, 3, or 4; the lower limit that the measurement is compared against", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit1Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 1; range 1 to 15; default is 1", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit2Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 2; range 1 to 15; default is 2", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit3Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 3; range 1 to 15; default is 4", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "limit4Pattern", - "description": "The bit pattern that is sent when the measurement passes limit 4; range 1 to 15; default is 8", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "allPattern", - "description": "The bit pattern that is sent when all limits have failed; 1 to 15; default is\u00a015", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startInLine", - "description": "The input line that starts the test; 5 for digital line 5, 6 for digital line 6, or 7 for external in; default is 5", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "startDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "endDelay", - "description": "The delay time after the measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "number", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "bufferName", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer; defaults to defbuffer1", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern, bufferName)" - ], - "overloads": [ - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low)", - "trigger.model.load(SortBinning, components, startInLine, startDelay, endDelay, limit1High, limit1Low, limit1Pattern, allPattern, limit2High, limit2Low, limit2Pattern, limit3High, limit3Low, limit3Pattern, limit4High, limit4Low, limit4Pattern)" - ], - "examples": [ - { - "example": "components;", - "description": "The number of components to measure (1 to 268,435,455)\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.model.load() - Keithley2001", - "webhelpfile": "46073.htm", - "signature": "trigger.model.load(Keithley2001, arm1Bypass, arm1Source, arm1Count, arm2Bypass, arm2Source, arm2Count, arm2Delay, trigBypass, trigSource, trigCount, trigDelay)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function loads a trigger-model template configuration that emulates a Keithley Instruments 2001 trigger model.", - "details": "If the trigger layer is not bypassed, the external trigger in/out rear-panel terminal is asserted. The arm layers do not assert the external in/out terminal.You can use this template to emulate trigger models for products such as the Keithley Instruments Model\u00a02000 and Model\u00a02001 if you use only one of the arm layers. Set the other arm layers to a source of trigger.EVENT_NONE, a count of 1, and a delay of 0 to simulate the immediate trigger option of a Model\u00a02001 trigger model.After selecting a trigger-model template, you can view the trigger-model blocks in a graphical format by pressing the front-panel MENU key and under Trigger, selecting Configure. You can also add or delete blocks and change trigger-model settings from this screen. You can use the trigger.model.getblocklist() command to view the trigger model blocks in a list format.Refer to the application notes for the DMM7510 on the Keithley Instruments website for an example with additional detail about this command.", - "param_info": [ - { - "name": "Keithley2001", - "description": "load function constant param", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "arm1Bypass", - "description": "Bypass Arm 1", - "enum": "trigger.ON nil|trigger.OFF nil", - "type": "triggermodelloadKeithley2001arm1Bypass", - "range": "" - }, - { - "name": "arm1Source", - "description": "The event that triggers Arm 1; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "arm1Count", - "description": "The number of times to repeat the Arm 1 layer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "arm2Bypass", - "description": "Bypass Arm 2", - "enum": "trigger.ON nil|trigger.OFF nil", - "type": "triggermodelloadKeithley2001arm2Bypass", - "range": "" - }, - { - "name": "arm2Source", - "description": "The event that triggers Arm 2; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "arm2Count", - "description": "The number of times to repeat the Arm 2 layer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "arm2Delay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "any", - "range": "(167\u00a0ns to 10\u00a0ks)" - }, - { - "name": "trigBypass", - "description": "Bypass the trigger layer", - "enum": "trigger.ON nil|trigger.OFF nil", - "type": "triggermodelloadKeithley2001trigBypass", - "range": "" - }, - { - "name": "trigSource", - "description": "The event that triggers the trigger layer; see Details", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "trigCount", - "description": "The number of times to repeat the trigger layer", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "trigDelay", - "description": "The delay time before each measurement (167\u00a0ns to 10\u00a0ks); default is 0 for no delay", - "enum": "", - "type": "any", - "range": "(167\u00a0ns to 10\u00a0ks)" - } - ], - "usage": [ - "trigger.model.load(Keithley2001, arm1Bypass, arm1Source, arm1Count, arm2Bypass, arm2Source, arm2Count, arm2Delay, trigBypass, trigSource, trigCount, trigDelay)" - ], - "overloads": [], - "examples": [ - { - "example": "No trigger event (immediate);", - "description": "trigger.EVENT_NONE\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dmm.measure.bias.actual", - "webhelpfile": "46264.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the amount of current the instrument is sourcing when it makes measurements.", - "details": "Reads the actual amount of current that is sourced by the instrument when a measurement is made.For the 1 \u03a9 to 1 M\u03a9 ranges, a constant current source is used to calculate resistance. The dmm.measure.bias.actual attribute returns the calibrated current for the programmed range. For the 10\u00a0M\u03a9 to 1\u00a0G\u03a9 ranges, the DMM7510 uses the ratiometric technique. Ratiometric ohms measurement has lower noise and better repeatability for testing devices at ranges greater than 1\u00a0M\u03a9, but has variable current through the device under test (DUT). The dmm.measure.bias.actual attribute returns the ideal maximum current when the DUT is at 0 \u03a9 (0.69 \u00b5A).", - "param_info": [ - { - "name": "value", - "description": "The actual bias level", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.bias.actual" - ], - "overloads": [], - "examples": [ - { - "example": "print(dmm.measure.bias.actual);", - "description": "Read the actual bias level.\n" - } - ], - "related_commands": [ - "dmm.measure.bias.level" - ] - }, - { - "name": "bufferVar.extravalues", - "webhelpfile": "46323.htm", - "signature": "bufferVar.extravalues[N]", - "command_return": "extraValue", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the additional values in a reading buffer.", - "details": "This attribute contains an additional value, such as the sense voltage from a DC voltage ratio measurement. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extravalue", - "description": "The extra values for readings", - "enum": "", - "type": "number[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraValue = bufferVar.extravalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - }, - { - "example": "reset();testData = buffer.make(50, buffer.STYLE_FULL);dmm.measure.func = dmm.FUNC_DCV_RATIO;dmm.measure.read(testData);print(testData.extravalues[1]);printbuffer(1, 1, testData.extravalues);", - "description": "Reset the instrument.\n--- --Create a reading buffer named testData that can hold a maximum of 50 readings and is set to the style full.\n--- --Make a measurement and save it to the testData buffer.\n--- --Print the first extra reading value.\n--- --Example output:\n--- ---7.4235309424\n--- ---7.4235309424\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "acal.lastrun.tempdiff", - "webhelpfile": "46331.htm", - "signature": "", - "command_return": "temperature", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute returns the difference between the internal temperature and the temperature when autocalibration was last run.", - "details": "The temperature is displayed in Celsius (\u00b0C).The instrument updates the internal temperature value when the instrument refreshes autozero. If autozero is set to off or if autozero is not available for the selected function (such as capacitance, continuity, frequency, or period), the internal temperature value is not updated.", - "param_info": [ - { - "name": "temperature", - "description": "The internal temperature", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "temperature = acal.lastrun.tempdiff" - ], - "overloads": [], - "examples": [ - { - "example": "print(acal.lastrun.tempdiff);", - "description": "Returns the difference between the temperature of the instrument when autocalibration was run and the present internal temperature.\n--- --Example output:\n--- --4.5678\n" - } - ], - "related_commands": [ - "acal.lastrun.internaltemp", - "acal.run()" - ] - }, - { - "name": "dmm.digitize.dbreference", - "webhelpfile": "46371.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "1 (1\u00a0V)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the decibel (dB) reference setting for the DMM in volts.", - "details": "This value only applies when the unit setting for the function is set to decibels.", - "param_info": [ - { - "name": "value", - "description": "1e-7\u00a0V to 1000\u00a0V", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "value = dmm.digitize.dbreference", - "dmm.digitize.dbreference = value", - "value = dmm.measure.getattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_DB_REFERENCE)", - "dmm.measure.setattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_DB_REFERENCE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.unit = dmm.UNIT_DB;dmm.digitize.dbreference = 5;", - "description": "Sets the units to decibel and sets the dB reference to 5 for DC volts.\n" - } - ], - "related_commands": [ - "dmm.digitize.unit", - "dmm.measure.dbreference", - "dmm.measure.dbmreference" - ] - }, - { - "name": "buffer.write.format()", - "webhelpfile": "46427.htm", - "signature": "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function sets the units and number of digits of the readings that are written into the reading buffer.", - "details": "This command is valid when the buffer style is writable or full writable. When the buffer style is set to full writable, you can include an extra value.The format defines the units and the number of digits that are reported for the data. This command affects how the data is shown in the reading buffer and what is shown on the front-panel Home, Histogram, Reading Table, and Graph screens.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "units", - "description": "The units for the first measurement in the buffer index", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "bufferwriteformatunits", - "range": "" - }, - { - "name": "displayDigits", - "description": "The number of digits to use for the first measurement", - "enum": "buffer.DIGITS_3_5 nil|buffer.DIGITS_4_5 nil|buffer.DIGITS_5_5 nil|buffer.DIGITS_6_5 nil|buffer.DIGITS_7_5 nil|buffer.DIGITS_8_5 nil", - "type": "bufferwriteformatdisplayDigits", - "range": "" - }, - { - "name": "extraUnits", - "description": "The units for the second measurement in the buffer index; the selections are the same as units (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for units", - "enum": "", - "type": "bufferwriteformatunits", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "extraDigits", - "description": "The number of digits to use for the second measurement; the selections are the same as displayDigits (only valid for buffer style WRITABLE_FULL); if not specified, uses the value for displayDigits", - "enum": "", - "type": "bufferwriteformatdisplayDigits", - "range": "(only valid for buffer style WRITABLE_FULL)" - } - ], - "usage": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits, extraDigits)" - ], - "overloads": [ - "buffer.write.format(bufferVar, units, displayDigits)", - "buffer.write.format(bufferVar, units, displayDigits, extraUnits)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1.0000000000e+00, Watt DC, 2.0000000000e+00, Watt DC, 3.0000000000e+00, Watt DC, 4.0000000000e+00, Watt DC, 5.0000000000e+00, Watt DC, 6.0000000000e+00, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.unit()", - "buffer.write.reading()" - ] - }, - { - "name": "buffer.write.reading()", - "webhelpfile": "46428.htm", - "signature": "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to write readings into the reading buffer.", - "details": "For buffers that are set to the writable buffer style:For buffers that are set to the full writable buffer style:This command writes the data you specify into a reading buffer. The reading buffer must be set to the writable or full writable style, which is set when you make the buffer.Data must be added in chronological order. If the time is not specified for a reading, it is set to one integer second after the last reading. As you write the data, the front-panel home screen updates and displays the reading you entered.The status parameter provides additional information about the reading. The options are shown in the following table.", - "param_info": [ - { - "name": "bufferVar", - "description": "The name of the buffer", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "readingValue", - "description": "The first value that is recorded in the buffer index", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "extraValue", - "description": "A second value that is recorded in the buffer index (only valid for buffer style WRITABLE_FULL)", - "enum": "", - "type": "integer", - "range": "(only valid for buffer style WRITABLE_FULL)" - }, - { - "name": "seconds", - "description": "An integer that represents the seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "fractionalSeconds", - "description": "The portion of the time that represents the fractional seconds", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "status", - "description": "Additional information about the reading; see Details", - "enum": "", - "type": "readingStatus", - "range": "" - } - ], - "usage": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds, status)" - ], - "overloads": [ - "buffer.write.reading(bufferVar, readingValue)", - "buffer.write.reading(bufferVar, readingValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, extraValue)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds)", - "buffer.write.reading(bufferVar, readingValue, seconds, fractionalSeconds, status)", - "buffer.write.reading(bufferVar, readingValue, extraValue, seconds, fractionalSeconds)" - ], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1);buffer.write.reading(extBuffer, 2);buffer.write.reading(extBuffer, 3);buffer.write.reading(extBuffer, 4);buffer.write.reading(extBuffer, 5);buffer.write.reading(extBuffer, 6);printbuffer(1, 6, extBuffer.readings, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution.\n--- --Write 6 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - }, - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.units, extBuffer.extravalues, extBuffer.units);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 7, Watt DC, 2, Watt DC, 8, Watt DC, 3, Watt DC, 9, Watt DC, 4, Watt DC, 10, Watt DC, 5, Watt DC, 11, Watt DC, 6, Watt DC, 12, Watt DC\n" - } - ], - "related_commands": [ - "buffer.make()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.startindex", - "webhelpfile": "56793.htm", - "signature": "bufferVar.startindex", - "command_return": "startIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the starting index in a reading buffer.", - "details": "Use this attribute to find the starting index in a reading buffer.", - "param_info": [ - { - "name": "startIndex", - "description": "Starting index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.startindex = startIndex " - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);dmm.measure.count = 6;dmm.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n" - } - ], - "related_commands": [ - "bufferVar.endindex", - "buffer.make()" - ] - }, - { - "name": "bufferVar.endindex", - "webhelpfile": "56794.htm", - "signature": "bufferVar.endindex", - "command_return": "endIndex", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute indicates the last index in a reading buffer.", - "details": "Use this attribute to find the ending index in a reading buffer.", - "param_info": [ - { - "name": "endIndex", - "description": "Ending index of the buffer", - "enum": "", - "type": "integer", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - } - ], - "usage": [ - "bufferVar.endindex = endIndex" - ], - "overloads": [], - "examples": [ - { - "example": "test1 = buffer.make(100);dmm.measure.count = 6;dmm.measure.read(test1);print(test1.startindex, test1.endindex, test1.capacity);dmm.measure.read(test1);print(test1.startindex, test1.endindex);", - "description": "Create a buffer named test1 with a capacity of 100 readings.Set the measure count to 6.\n--- --Make measurements and store them in buffer test1.Get the start index, end index, and capacity of test1.\n--- --Output:\n--- --1, 6, 100\n--- --Make six more measurements and store them in buffer test1.\n--- --Get the start index and end index of test1.\n--- --Output:\n--- --1, 12\n" - } - ], - "related_commands": [ - "bufferVar.startindex", - "buffer.make()" - ] - }, - { - "name": "fan.level", - "webhelpfile": "56834.htm", - "signature": "", - "command_return": "fanLevel", - "type": "Attribute (RW)", - "default_value": "fan.LEVEL_NORMAL\n", - "tsp_link": "Yes\n", - "description": "This attribute sets the speed of the instrument fan.", - "details": "Use this command to lower the audible noise level of the instrument fan.When you set the fan level to quiet:Instrument performance can be improved with the use of autocalibration. Allow 90 minutes between changing fan level and running autocalibration.", - "param_info": [ - { - "name": "fanLevel", - "description": "The fan level", - "enum": "fan.LEVEL_NORMAL nil|fan.LEVEL_QUIET nil", - "type": "fanlevelfanLevel", - "range": "" - } - ], - "usage": [ - "fanLevel = fan.level", - "fan.level = fanLevel" - ], - "overloads": [], - "examples": [ - { - "example": "fan.level = fan.LEVEL_QUIET;", - "description": "Set the fan speed to the quiet level. The audible noise of the fan decreases.\n" - } - ], - "related_commands": [ - "Autocalibration", - "acal.run()" - ] - }, - { - "name": "trigger.model.pause()", - "webhelpfile": "72471.htm", - "signature": "trigger.model.pause()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function pauses a running trigger model.", - "details": "This command pauses the trigger model.To continue the trigger model, send the resume command.", - "param_info": [ - { - "name": "reset()dmm.measure.func = dmm.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.pause()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();dmm.measure.func = dmm.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.resume()" - ] - }, - { - "name": "trigger.model.resume()", - "webhelpfile": "73512.htm", - "signature": "trigger.model.resume()", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function continues a paused trigger model.", - "details": "This command continues running the trigger model operation if the trigger model was paused.", - "param_info": [ - { - "name": "reset()dmm.measure.func = dmm.FUNC_DC_VOLTAGEtrigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1)trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0)trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE)trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY)trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP)trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1)trigger.model.initiate()trigger.model.pause()delay(10)trigger.model.resume()waitcomplete()print(defbuffer1.n)", - "description": "", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.", - "description": "", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "trigger.model.resume()" - ], - "overloads": [], - "examples": [ - { - "example": "reset();dmm.measure.func = dmm.FUNC_DC_VOLTAGE;trigger.model.setblock(1, trigger.BLOCK_BUFFER_CLEAR, defbuffer1);trigger.model.setblock(2, trigger.BLOCK_DELAY_CONSTANT, 0);trigger.model.setblock(3, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_INFINITE);trigger.model.setblock(4, trigger.BLOCK_WAIT, trigger.EVENT_DISPLAY);trigger.model.setblock(5, trigger.BLOCK_MEASURE_DIGITIZE, defbuffer1, trigger.COUNT_STOP);trigger.model.setblock(6, trigger.BLOCK_NOTIFY, trigger.EVENT_NOTIFY1);trigger.model.initiate();trigger.model.pause();delay(10);trigger.model.resume();waitcomplete();print(defbuffer1.n);", - "description": "Set up a trigger model, then run it, pause for delay of 10 seconds, then resume it.\n" - } - ], - "related_commands": [ - "trigger.model.initiate()", - "trigger.model.pause()" - ] - }, - { - "name": "buffer.math()", - "webhelpfile": "73595.htm", - "signature": "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to run a mathematical expression on a measurement. The expression is applied when the measurement is placed in the reading buffer.", - "details": "", - "param_info": [ - { - "name": "readingBuffer", - "description": "The name of the reading buffer; the reading buffer selected must be set to the style FULL", - "enum": "", - "type": "bufferVar", - "range": "" - }, - { - "name": "unit", - "description": "The units to be applied to the value generated by the expression", - "enum": "buffer.UNIT_AMP nil|buffer.UNIT_AMP_AC nil|buffer.UNIT_CELSIUS nil|buffer.UNIT_CUSTOM1 nil|buffer.UNIT_CUSTOM2 nil|buffer.UNIT_CUSTOM3 nil|buffer.UNIT_DAC nil|buffer.UNIT_DBM nil|buffer.UNIT_DECIBEL nil|buffer.UNIT_DIO nil|buffer.UNIT_FAHRENHEIT nil|buffer.UNIT_FARAD nil|buffer.UNIT_HERTZ nil|buffer.UNIT_KELVIN nil|buffer.UNIT_NONE nil|buffer.UNIT_OHM nil|buffer.UNIT_PERCENT nil|buffer.UNIT_RATIO nil|buffer.UNIT_RECIPROCAL nil|buffer.UNIT_SECOND nil|buffer.UNIT_TOT nil|buffer.UNIT_VOLT nil|buffer.UNIT_VOLT_AC nil|buffer.UNIT_WATT nil|buffer.UNIT_X nil", - "type": "buffermathunit", - "range": "" - }, - { - "name": "constant0", - "description": "The constant to be used for c0 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant1", - "description": "The constant to be used for c1 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant2", - "description": "The constant to be used for c2 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant3", - "description": "The constant to be used for c3 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant4", - "description": "The constant to be used for c4 in the expression", - "enum": "", - "type": "number", - "range": "" - }, - { - "name": "constant5", - "description": "The constant to be used for c5 in the expression", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_POLY, constant0, constant1, constant2, constant3, constant4, constant5)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)" - ], - "overloads": [ - "buffer.math(readingBuffer, unit, EXPR_ADD)", - "buffer.math(readingBuffer, unit, EXPR_RATE)", - "buffer.math(readingBuffer, unit, EXPR_NONE)", - "buffer.math(readingBuffer, unit, EXPR_LOG10)", - "buffer.math(readingBuffer, unit, EXPR_SQROOT)", - "buffer.math(readingBuffer, unit, EXPR_DIVIDE)", - "buffer.math(readingBuffer, unit, EXPR_AVERAGE)", - "buffer.math(readingBuffer, unit, EXPR_SUBTRACT)", - "buffer.math(readingBuffer, unit, EXPR_MULTIPLY)", - "buffer.math(readingBuffer, unit, EXPR_EXPONENT)", - "buffer.math(readingBuffer, unit, EXPR_RECIPROCAL)", - "buffer.math(readingBuffer, unit, EXPR_POWER, constant0)" - ], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);dmm.measure.func = dmm.FUNC_DC_VOLTAGE;\u00a0;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", dmm.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);\u00a0;print(\"Extra value reading 1: \", mathExp.extravalues[1]);print(\"Extra value reading 2: \", mathExp.extravalues[2]);print(\"Extra value reading 3: \", mathExp.extravalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: 6.3863430578e-05\n--- --Reading: 6.7818055872e-05\n--- --Reading: 1.9871571784e-05\n--- --Extra value reading 1: 6.3863430578e-05\n--- --Extra value reading 2: 4.3310937031e-09\n--- --Extra value reading 3: 1.3476513655e-09\n" - } - ], - "related_commands": [ - "buffer.unit()" - ] - }, - { - "name": "buffer.unit()", - "webhelpfile": "76401.htm", - "signature": "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)", - "command_return": "", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function allows you to create up to three custom units of measure for use in buffers.", - "details": "You can use custom units of measures in buffer math and writable buffers.If you specify more than two characters, the additional characters are ignored. Some characters are converted to other symbols:This unit is reset when power is cycled. It is not affected by reset.", - "param_info": [ - { - "name": "UNIT_CUSTOMN", - "description": "Custom unit user can create, The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "bufferCustomUnit", - "range": "" - }, - { - "name": "N", - "description": "The number of the custom unit, 1, 2, or 3", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "unitOfMeasure", - "description": "A string that defines the custom unit; up to three characters; defaults are X for custom unit 1, Y for unit 2, and Z for unit 3", - "enum": "", - "type": "string", - "range": "" - } - ], - "usage": [ - "buffer.unit(UNIT_CUSTOMN, unitOfMeasure)" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(200, buffer.STYLE_FULL);dmm.measure.func = dmm.FUNC_DC_VOLTAGE;buffer.unit(buffer.UNIT_CUSTOM1, \"fb\") ;\u00a0;buffer.math(mathExp, buffer.UNIT_CUSTOM1, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading \"..x..\":\", dmm.measure.read(mathExp));end;\u00a0;display.changescreen(display.SCREEN_READING_TABLE);for x = 1, 3 do ; print(\"Extra value reading \"..x..\":\", mathExp.extravalues[x]);end;", - "description": "Instrument has terminals set to FRONT.\n--- --Reset the instrument.\n--- --Make a buffer named mathExp set to hold 200 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the customer 1 buffer unit to fb.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make 3 readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading 1: 0.00015611271869\n--- --Reading 2: 9.0539004907e-05\n--- --Reading 3: 0.30001141669554\n--- --Extra value reading 1: 0.00015611271869\n--- --Extra value reading 2: 1.4134290203e-08\n--- --Extra value reading 3: 1.0336562635e-08\n" - } - ], - "related_commands": [ - "buffer.math()", - "buffer.write.format()" - ] - }, - { - "name": "bufferVar.extraformattedvalues", - "webhelpfile": "81089.htm", - "signature": "bufferVar.extraformattedvalues[N]", - "command_return": "extraFormat", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the measurement and the unit of measure of the additional values in a reading buffer.", - "details": "This attribute contains the measurement and the unit of measure of an additional value, such as the sense voltage from a DC voltage ratio measurement. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraFormat", - "description": "The measurement and unit of measure of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraFormat = bufferVar.extraformattedvalues[N]" - ], - "overloads": [], - "examples": [ - { - "example": "reset();mathExp = buffer.make(400, buffer.STYLE_FULL);dmm.measure.func = dmm.FUNC_DC_VOLTAGE;buffer.math(mathExp, buffer.UNIT_NONE, buffer.EXPR_MULTIPLY);for x = 1, 3 do ; print(\"Reading: \", dmm.measure.read(mathExp));end;display.changescreen(display.SCREEN_READING_TABLE);print(\"Extra value reading 1: \", mathExp.extraformattedvalues[1]);print(\"Extra value reading 2: \", mathExp.extraformattedvalues[2]);print(\"Extra value reading 3: \", mathExp.extraformattedvalues[3]);", - "description": "Reset the instrument.\n--- --Make a buffer named mathExp set to hold 400 readings with a buffer style of FULL.\n--- --Set the measure function to DC voltage.\n--- --Set the buffer math expression to multiply readings against the previous readings.\n--- --Make three readings.\n--- --Display the reading table on the front panel of the instrument, where you can view the extra readings.\n--- --Print the extra values (the calculated values).\n--- --Example output:\n--- --Reading: \t7.1233589551e-06\n--- --Reading: \t7.1233080234e-06\n--- --Reading: \t7.2616603575e-06\n--- --Extra value reading 1: \t+7.1233590 u\n--- --Extra value reading 2: \t+50.741880 p\n--- --Extra value reading 3: \t+51.727043 p\n" - }, - { - "example": "reset();testData = buffer.make(50, buffer.STYLE_FULL);dmm.measure.func = dmm.FUNC_DCV_RATIO;dmm.measure.read(testData);printbuffer(1, testData.n, testData.extraformattedvalues);", - "description": "Reset the instrument.\n--- --Create a reading buffer named testData that can hold a maximum of 50 readings and is set to the style full.\n--- --Make a measurement and save it to the testData buffer.\n--- --Print the first extra value with the unit of measure.\n--- --Example output:\n--- ---5.716896 RA\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "bufferVar.extravalueunits", - "webhelpfile": "81090.htm", - "signature": "bufferVar.extravalueunits[N]", - "command_return": "extraUnits", - "type": "Attribute (R)", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This attribute contains the units of the additional values in a reading buffer.", - "details": "This attribute contains the unit of measure of an additional value, such as the sense voltage from a DC voltage ratio measurement. The reading buffer style must be set to full to use this option.", - "param_info": [ - { - "name": "extraUnits", - "description": "The units of the extra values for readings", - "enum": "", - "type": "string[]", - "range": "" - }, - { - "name": "bufferVar", - "description": "The name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer", - "enum": "", - "type": "bufferVar", - "range": "(defbuffer1 or defbuffer2)" - }, - { - "name": "N", - "description": "The reading number N; can be any value from 1 to the number of readings in the buffer; use the bufferVar.n command to determine the number of readings in the\u00a0buffer", - "enum": "", - "type": "number", - "range": "" - } - ], - "usage": [ - "extraUnits = bufferVar.extravalueunits[N]" - ], - "overloads": [], - "examples": [ - { - "example": "extBuffer = buffer.make(100, buffer.STYLE_WRITABLE_FULL);buffer.write.format(extBuffer, buffer.UNIT_WATT, buffer.DIGITS_3_5, buffer.UNIT_WATT, buffer.DIGITS_3_5);buffer.write.reading(extBuffer, 1, 7);buffer.write.reading(extBuffer, 2, 8);buffer.write.reading(extBuffer, 3, 9);buffer.write.reading(extBuffer, 4, 10);buffer.write.reading(extBuffer, 5, 11);buffer.write.reading(extBuffer, 6, 12);printbuffer(1, 6, extBuffer.readings, extBuffer.extravalueunits);", - "description": "Creates a 100-point reading buffer named extBuffer. Style is full writable.\n--- --Set the data format to show units of watts with 3\u00bd digit resolution for the first value and for the second value in the buffer index.\n--- --Write 12 pieces of data into the buffer.\n--- --Print the buffer, including the readings and extra value units.\n--- --Read the buffer.\n--- --Output:\n--- --1, Watt DC, 2, Watt DC, 3, Watt DC, 4, Watt DC, 5, Watt DC, 6, Watt DC\n" - }, - { - "example": "reset();testData = buffer.make(50, buffer.STYLE_FULL);dmm.measure.func = dmm.FUNC_DCV_RATIO;dmm.measure.read(testData);printbuffer(1, testData.n, testData.extravalueunits);", - "description": "Reset the instrument.\n--- --Create a reading buffer named testData that can hold a maximum of 50 readings and is set to the style\u00a0full.\n--- --Make a measurement and save it to the testData buffer.\n--- --Print the unit of measure of the first extra value.\n--- --Example output:\n--- --Ratio\n" - } - ], - "related_commands": [ - "buffer.delete()", - "buffer.make()", - "bufferVar.clear()", - "print()", - "printbuffer()" - ] - }, - { - "name": "dmm.measure.dbmreference", - "webhelpfile": "81432.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "75 (75\u00a0\u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the decibel-milliwatts (dBm) reference.", - "details": "This value only applied when the unit setting for the function is set to dBm.", - "param_info": [ - { - "name": "value", - "description": "The dBm impedance value (1\u00a0\u03a9 to 9999\u00a0\u03a9)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u03a9 to 9999\u00a0\u03a9)" - }, - { - "name": "function", - "description": "See Functions", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "value = dmm.measure.dbmreference", - "dmm.measure.dbmreference = value", - "value = dmm.measure.getattribute(function, ATTR_MEAS_DBM_REFERENCE)", - "dmm.measure.setattribute(function, ATTR_MEAS_DBM_REFERENCE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.func = dmm.FUNC_DC_VOLTAGE;dmm.measure.unit = dmm.UNIT_DBM;dmm.measure.dbmreference = 85;", - "description": "Sets the units to dBm and sets the dBm reference to 85\u00a0\u03a9.\n" - } - ], - "related_commands": [ - "dmm.digitize.dbmreference", - "dmm.measure.dbreference", - "dmm.measure.unit" - ] - }, - { - "name": "dmm.digitize.dbmreference", - "webhelpfile": "81719.htm", - "signature": "", - "command_return": "value", - "type": "Attribute (RW)", - "default_value": "75 (75\u00a0\u03a9)\n", - "tsp_link": "Yes\n", - "description": "This attribute defines the decibel-milliwatts (dBm) reference.", - "details": "This value only applied when the unit setting for the function is set to dBm.", - "param_info": [ - { - "name": "value", - "description": "The dBm reference value (1\u00a0\u03a9 to 9999\u00a0\u03a9)", - "enum": "", - "type": "number", - "range": "(1\u00a0\u03a9 to 9999\u00a0\u03a9)" - } - ], - "usage": [ - "value = dmm.digitize.dbmreference", - "dmm.digitize.dbmreference = value", - "value = dmm.measure.getattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_DBM_REFERENCE)", - "dmm.measure.setattribute(FUNC_DIGITIZE_VOLTAGE, ATTR_DIGI_DBM_REFERENCE, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.digitize.func = dmm.FUNC_DIGITIZE_VOLTAGE;dmm.digitize.unit = dmm.UNIT_DBM;dmm.digitize.dbmreference = 85;", - "description": "Sets the units to dBm and sets the dBm resistance to 85\u00a0\u03a9.\n" - } - ], - "related_commands": [ - "Show voltage readings in decibel-milliwatts", - "dmm.digitize.dbreference", - "dmm.digitize.unit", - "dmm.measure.dbmreference" - ] - }, - { - "name": "display.activebuffer", - "webhelpfile": "81840.htm", - "signature": "", - "command_return": "bufferName", - "type": "Attribute (RW)", - "default_value": "defbuffer1\n", - "tsp_link": "Yes\n", - "description": "This attribute determines which buffer is used for measurements that are displayed on the front panel.", - "details": "The buffer defined by this command is used to store measurements data and is shown in the reading buffer indicator on the home screen of the instrument.", - "param_info": [ - { - "name": "bufferName", - "description": "The name of the buffer to make active", - "enum": "", - "type": "bufferVar", - "range": "" - } - ], - "usage": [ - "bufferName = display.activebuffer", - "display.activebuffer = bufferName" - ], - "overloads": [], - "examples": [ - { - "example": "display.activebuffer = buffer2;", - "description": "Set the front panel to use buffer2 as the active reading buffer.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "trigger.continuous", - "webhelpfile": "88463.htm", - "signature": "", - "command_return": "setting", - "type": "Attribute (RW)", - "default_value": "trigger.CONT_AUTO\n", - "tsp_link": "Yes\n", - "description": "This attribute determines the trigger mode setting after bootup.", - "details": "Conditions must be valid before continuous measurements can start.When the restart parameter is selected, the instrument is placed in local mode, aborts any running scripts, and aborts any trigger models that are running. If the command is in a script, it is the last command that runs before the script is aborted. The restart parameter is not stored in nonvolatile memory, so it does not affect start up behavior.The off and automatic parameters are stored in nonvolatile memory, so they affect start up behavior.", - "param_info": [ - { - "name": "setting", - "description": "Do not start continuous measurements after boot", - "enum": "trigger.CONT_OFF nil|trigger.CONT_AUTO nil|trigger.CONT_RESTART nil", - "type": "triggercontinuoussetting", - "range": "" - } - ], - "usage": [ - "setting = trigger.continuous", - "trigger.continuous = setting" - ], - "overloads": [], - "examples": [ - { - "example": "trigger.continuous = trigger.CONT_OFF;", - "description": "When the instrument starts up, the measurement method is set to idle.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "available()", - "webhelpfile": "89066.htm", - "signature": "available(functionality)", - "command_return": "presence", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "No\n", - "description": "This function checks for the presence of specific instrument functionality.", - "details": "", - "param_info": [ - { - "name": "presence", - "description": "If the functionality is present, returns true; if not, returns false", - "enum": "", - "type": "boolean", - "range": "" - }, - { - "name": "functionality", - "description": "The functionality to check for", - "enum": "", - "type": "functionality", - "range": "" - } - ], - "usage": [ - "presence = available(functionality)" - ], - "overloads": [], - "examples": [ - { - "example": "print(available(gpib));", - "description": "Returns true if GPIB communications are available. Returns false if GPIB communications are not available.\n" - } - ], - "related_commands": [ - "None" - ] - }, - { - "name": "dmm.measure.getattribute()", - "webhelpfile": "91266.htm", - "signature": "dmm.measure.getattribute(function, setting)", - "command_return": "value", - "type": "Function", - "default_value": "\u00a0\n", - "tsp_link": "Yes\n", - "description": "This function returns the setting for a function attribute.", - "details": "The options for function are shown in the following table.You can retrieve one attribute at a time.", - "param_info": [ - { - "name": "value", - "description": "The attribute value", - "enum": "", - "type": "any", - "range": "" - }, - { - "name": "function", - "description": "The measurement function; see Details", - "enum": "", - "type": "functions", - "range": "" - }, - { - "name": "setting", - "description": "The attribute for the function; refer to dmm.measure.setattribute() for available settings", - "enum": "", - "type": "functionAttributes", - "range": "()" - } - ], - "usage": [ - "value = dmm.measure.getattribute(function, setting)" - ], - "overloads": [], - "examples": [ - { - "example": "print(dmm.measure.getattribute(dmm.FUNC_DC_VOLTAGE, dmm.ATTR_MEAS_RANGE));print(dmm.measure.getattribute(dmm.FUNC_DC_VOLTAGE, dmm.ATTR_MEAS_NPLC));print(dmm.measure.getattribute(dmm.FUNC_DC_VOLTAGE, dmm.ATTR_MEAS_DIGITS));", - "description": "Retrieve the range, NPLC, and digits settings for the DC voltage function.\n--- --Example return:\n--- --0.02\n--- --1\n--- --dmm.DIGITS_4_5\n" - } - ], - "related_commands": [ - "dmm.measure.setattribute()" - ] - }, - { - "name": "dmm.measure.setattribute()", - "webhelpfile": "91267.htm", - "signature": "dmm.measure.setattribute(function, setting, value)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to set up a measure function whether or not the function is active.", - "details": "The lists that follow the example and \"also see\" listings show the parameters that are available for each function. Each parameter includes a link to the descriptions of the corresponding TSP command descriptions. The options for each parameter are the same as the settings for the TSP commands.Aperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTOAuto zero: dmm.ATTR_MEAS_AUTO_ZEROdB reference: dmm.ATTR_MEAS_DB_REFERENCEdBm reference: dmm.ATTR_MEAS_DBM_REFERENCEDisplay digits: dmm.ATTR_MEAS_DIGITSInput impedance: dmm.ATTR_MEAS_INPUT_IMPEDANCELine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCRange:\u00a0dmm.ATTR_MEAS_RANGEUnit: dmm.ATTR_MEAS_UNITUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTOAuto zero: dmm.ATTR_MEAS_AUTO_ZEROdB reference: dmm.ATTR_MEAS_DB_REFERENCEdBm reference: dmm.ATTR_MEAS_DBM_REFERENCEDetector bandwidth: dmm.ATTR_MEAS_DETECTBWDisplay digits: dmm.ATTR_MEAS_DIGITSNPLC: dmm.ATTR_MEAS_NPLCMeasure count: dmm.ATTR_MEAS_COUNTRange:\u00a0dmm.ATTR_MEAS_RANGEUnit: dmm.ATTR_MEAS_UNITUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTOAuto zero: dmm.ATTR_MEAS_AUTO_ZERODisplay digits: dmm.ATTR_MEAS_DIGITSLine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCRange:\u00a0dmm.ATTR_MEAS_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTOAuto zero: dmm.ATTR_MEAS_AUTO_ZERODetector bandwidth: dmm.ATTR_MEAS_DETECTBWDisplay digits: dmm.ATTR_MEAS_DIGITSMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCRange:\u00a0dmm.ATTR_MEAS_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_N3-wire RTD type: dmm.ATTR_MEAS_THREE_RTD4-wire RTD type: dmm.ATTR_MEAS_FOUR_RTDAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto zero: dmm.ATTR_MEAS_AUTO_ZERODisplay digits: dmm.ATTR_MEAS_DIGITSLine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCOffset Compensation: dmm.ATTR_MEAS_OFFCOMP_ENABLEOpen lead detector: dmm.ATTR_MEAS_OPEN_DETECTORRTD Alpha: dmm.ATTR_MEAS_RTD_ALPHARTD Beta: dmm.ATTR_MEAS_RTD_BETARTD Delta: dmm.ATTR_MEAS_RTD_DELTARTD Zero: dmm.ATTR_MEAS_RTD_ZEROSimulated reference temperature: dmm.ATTR_MEAS_SIM_REF_TEMPThermistor: dmm.ATTR_MEAS_THERMISTORThermocouple: dmm.ATTR_MEAS_THERMOCOUPLETransducer: dmm.ATTR_MEAS_TRANSDUCERUnit: dmm.ATTR_MEAS_UNITUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTOAuto zero: dmm.ATTR_MEAS_AUTO_ZERODisplay digits: dmm.ATTR_MEAS_DIGITSLine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCRange:\u00a0dmm.ATTR_MEAS_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTOAuto zero: dmm.ATTR_MEAS_AUTO_ZERODisplay digits: dmm.ATTR_MEAS_DIGITSDry circuit: dmm.ATTR_MEAS_DRY_CIRCUITLine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCOffset compensation: dmm.ATTR_MEAS_OFFCOMP_ENABLEOpen lead detector: dmm.ATTR_MEAS_OPEN_DETECTORRange:\u00a0dmm.ATTR_MEAS_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto zero: dmm.ATTR_MEAS_AUTO_ZEROBias level: dmm.ATTR_MEAS_BIAS_LEVELDisplay digits: dmm.ATTR_MEAS_DIGITSLine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTODisplay digits: dmm.ATTR_MEAS_DIGITSMeasure count: dmm.ATTR_MEAS_COUNTRange:\u00a0dmm.ATTR_MEAS_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAuto delay: dmm.ATTR_MEAS_AUTO_DELAYDisplay digits: dmm.ATTR_MEAS_DIGITSLine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYDisplay digits: dmm.ATTR_MEAS_DIGITSMeasure count: dmm.ATTR_MEAS_COUNTThreshold autorange: dmm.ATTR_MEAS_THRESHOLD_RANGE_AUTOThreshold level: dmm.ATTR_MEAS_THRESHOLD_LEVELThreshold range: dmm.ATTR_MEAS_THRESHOLD_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYMeasure count: dmm.ATTR_MEAS_COUNTThreshold autorange: dmm.ATTR_MEAS_THRESHOLD_RANGE_AUTOThreshold level: dmm.ATTR_MEAS_THRESHOLD_LEVELThreshold range: dmm.ATTR_MEAS_THRESHOLD_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAperture: dmm.ATTR_MEAS_APERTUREAuto delay: dmm.ATTR_MEAS_AUTO_DELAYAuto range: dmm.ATTR_MEAS_RANGE_AUTOAuto zero: dmm.ATTR_MEAS_AUTO_ZERODisplay digits: dmm.ATTR_MEAS_DIGITSLine sync: dmm.ATTR_MEAS_LINE_SYNCMeasure count: dmm.ATTR_MEAS_COUNTNPLC: dmm.ATTR_MEAS_NPLCRange:\u00a0dmm.ATTR_MEAS_RANGESense auto range: dmm.ATTR_MEAS_SENSE_RANGE_AUTOSense range: dmm.ATTR_MEAS_SENSE_RANGEUser delay N (where N is 1 to 5): dmm.ATTR_MEAS_USER_DELAY_NAC coupling filter: dmm.ATTR_DIGI_COUPLING_AC_FILTERAC coupling frequency: dmm.ATTR_DIGI_COUPLING_AC_FREQUENCYAperture: dmm.ATTR_DIGI_APERTURECount: dmm.ATTR_DIGI_COUNTDisplay digits: dmm.ATTR_DIGI_DIGITSRange: dmm.ATTR_DIGI_RANGESample rate: dmm.ATTR_DIGI_SAMPLE_RATESignal coupling type: dmm.ATTR_DIGI_COUPLING_TYPEUnit: dmm.ATTR_DIGI_UNITUser delay N (where N is 1 to 5): dmm.ATTR_DIGI_USER_DELAY_NAperture: dmm.ATTR_DIGI_APERTURECount: dmm.ATTR_DIGI_COUNTDecibel reference: dmm.ATTR_DIGI_DB_REFERENCEDecibel-milliwatts reference: dmm.ATTR_DIGI_DBM_REFERENCEDisplay digits: dmm.ATTR_DIGI_DIGITSInput impedance: dmm.ATTR_DIGI_INPUT_IMPEDANCERange: dmm.ATTR_DIGI_RANGERelative enable: dmm.ATTR_DIGI_REL_ENABLERelative level: dmm.ATTR_DIGI_REL_LEVELSample rate: dmm.ATTR_DIGI_SAMPLE_RATEUnit: dmm.ATTR_DIGI_UNITUser delay N (where N is 1 to 5): dmm.ATTR_DIGI_USER_DELAY_NEnable math: dmm.ATTR_MEAS_MATH_ENABLEb (offset) value: dmm.ATTR_MEAS_MATH_MXB_BFm (scalar) value: dmm.ATTR_MEAS_MATH_MXB_MFMath format: dmm.ATTR_MEAS_MATH_FORMATPercent: dmm.ATTR_MEAS_MATH_PERCENTEnable math: dmm.ATTR_DIGI_MATH_ENABLEb (offset) value: dmm.ATTR_DIGI_MATH_MXB_BFm (scalar) value: dmm.ATTR_DIGI_MATH_MXB_MFMath format: dmm.ATTR_DIGI_MATH_FORMATPercent: dmm.ATTR_DIGI_MATH_PERCENTLimit 1 audible: dmm.ATTR_MEAS_LIMIT_AUDIBLE_1Limit 1 auto clear: dmm.ATTR_MEAS_LIMIT_AUTO_CLEAR_1Limit 1 enable: dmm.ATTR_MEAS_LIMIT_ENABLE_1Limit 1 fail: dmm.ATTR_MEAS_LIMIT_FAIL_1Limit 1 high value: dmm.ATTR_MEAS_LIMIT_HIGH_1Limit 1 low value: dmm.ATTR_MEAS_LIMIT_LOW_1Limit 2 audible: dmm.ATTR_MEAS_LIMIT_AUDIBLE_2Limit 2 auto clear: dmm.ATTR_MEAS_LIMIT_AUTO_CLEAR_2Limit 2 enable: dmm.ATTR_MEAS_LIMIT_ENABLE_2Limit 2 fail: dmm.ATTR_MEAS_LIMIT_FAIL_2Limit 2 high value: dmm.ATTR_MEAS_LIMIT_HIGH_2Limit 2 low value: dmm.ATTR_MEAS_LIMIT_LOW_2Limit 1 audible: dmm.ATTR_DIGI_LIMIT_AUDIBLE_1Limit 1 auto clear: dmm.ATTR_DIGI_LIMIT_AUTO_CLEAR_1Limit 1 enable: dmm.ATTR_DIGI_LIMIT_ENABLE_1Limit 1 fail: dmm.ATTR_DIGI_LIMIT_FAIL_1Limit 1 high value: dmm.ATTR_DIGI_LIMIT_HIGH_1Limit 1 low value: dmm.ATTR_DIGI_LIMIT_LOW_1Limit 2 audible: dmm.ATTR_DIGI_LIMIT_AUDIBLE_2Limit 2 auto clear: dmm.ATTR_DIGI_LIMIT_AUTO_CLEAR_2Limit 2 enable: dmm.ATTR_DIGI_LIMIT_ENABLE_2Limit 2 fail: dmm.ATTR_DIGI_LIMIT_FAIL_2Limit 2 high value: dmm.ATTR_DIGI_LIMIT_HIGH_2Limit 2 low value: dmm.ATTR_DIGI_LIMIT_LOW_2Edge level: dmm.ATTR_MEAS_ATRIG_EDGE_LEVELEdge slope: dmm.ATTR_MEAS_ATRIG_EDGE_SLOPEHigh-frequency rejection: dmm.ATTR_MEAS_ATRIG_HFREJECTMode: dmm.ATTR_DIGI_ATRIG_MODEPulse condition: dmm.ATTR_MEAS_ATRIG_PULSE_CONDITIONPulse level: dmm.ATTR_MEAS_ATRIG_PULSE_LEVELPulse polarity: dmm.ATTR_MEAS_ATRIG_PULSE_POLARITYPulse width: dmm.ATTR_MEAS_ATRIG_PULSE_WIDTHWindow direction: dmm.ATTR_MEAS_ATRIG_WINDOW_DIRECTIONWindow level high: dmm.ATTR_MEAS_ATRIG_WINDOW_LEVEL_HIGHWindow level low: dmm.ATTR_MEAS_ATRIG_WINDOW_LEVEL_LOWEdge level: dmm.ATTR_DIGI_ATRIG_EDGE_LEVELEdge slope: dmm.ATTR_DIGI_ATRIG_EDGE_SLOPEHigh-frequency rejection: dmm.ATTR_DIGI_ATRIG_HFREJECTMode: dmm.ATTR_DIGI_ATRIG_MODEPulse condition: dmm.ATTR_DIGI_ATRIG_PULSE_CONDITIONPulse level: dmm.ATTR_DIGI_ATRIG_PULSE_LEVELPulse polarity: dmm.ATTR_DIGI_ATRIG_PULSE_POLARITYPulse width: dmm.ATTR_DIGI_ATRIG_PULSE_WIDTHWindow direction: dmm.ATTR_DIGI_ATRIG_WINDOW_DIRECTIONWindow level high: dmm.ATTR_DIGI_ATRIG_WINDOW_LEVEL_HIGHWindow level low: dmm.ATTR_DIGI_ATRIG_WINDOW_LEVEL_LOWFilter enable: dmm.ATTR_MEAS_FILTER_ENABLEFilter count: dmm.ATTR_MEAS_FILTER_COUNTFilter type: dmm.ATTR_MEAS_FILTER_TYPEFilter window: dmm.ATTR_MEAS_FILTER_WINDOWRelative offset enable: dmm.ATTR_MEAS_REL_ENABLERelative offset method (DCV ratio measurements only): dmm.ATTR_MEAS_REL_METHODRelative offset value: dmm.ATTR_MEAS_REL_LEVELRelative offset enable: dmm.ATTR_DIGI_REL_ENABLERelative offset value: dmm.ATTR_DIGI_REL_LEVEL", - "param_info": [ - { - "name": "function", - "description": "The function for which you are setting parameters; see Functions", - "enum": "", - "type": "functions", - "range": "" - }, - { - "name": "setting", - "description": "The parameter for the function; refer to Details and the tables following the examples", - "enum": "", - "type": "functionAttributes", - "range": "" - }, - { - "name": "value", - "description": "The parameter value", - "enum": "", - "type": "any", - "range": "" - } - ], - "usage": [ - "dmm.measure.setattribute(function, setting, value)" - ], - "overloads": [], - "examples": [ - { - "example": "dmm.measure.setattribute(dmm.FUNC_DC_CURRENT, dmm.ATTR_MEAS_RANGE, 35e-6);dmm.measure.setattribute(dmm.FUNC_DC_CURRENT, dmm.ATTR_MEAS_DIGITS, dmm.DIGITS_5_5);dmm.measure.setattribute(dmm.FUNC_DC_CURRENT, dmm.ATTR_MEAS_NPLC, 0.5);dmm.measure.configlist.create(\"measlist\");dmm.measure.configlist.storefunc(\"measlist\", dmm.FUNC_DC_CURRENT);", - "description": "Configure the DC Current function settings for the range, display resolution, and number of power line cycles (NPLCs) whether or not DC Current is the active function.\n--- --Create a configuration list named measlist.\n--- --Save the settings into measlist.\n" - } - ], - "related_commands": [ - "dmm.measure.configlist.storefunc()", - "dmm.measure.getattribute()" - ] - }, - { - "name": "dmm.measure.configlist.storefunc()", - "webhelpfile": "91273.htm", - "signature": "dmm.measure.configlist.storefunc(listName, function, index)", - "command_return": "", - "type": "Function", - "default_value": "Not applicable\n", - "tsp_link": "Yes\n", - "description": "This function allows you to store the settings for a measure function into a measure configuration list whether or not the function is active.", - "details": "You must create the configuration list before using this command.If index is not specified, the settings are stored to the next available index in the configuration list.You can set function to the values in the following table.", - "param_info": [ - { - "name": "listName", - "description": "Name of the configuration list in which to store the function settings", - "enum": "", - "type": "string", - "range": "" - }, - { - "name": "function", - "description": "The measure function settings to save into the configuration list; see Details", - "enum": "", - "type": "functions", - "range": "" - }, - { - "name": "index", - "description": "The number of the configuration list index in which to store the settings", - "enum": "", - "type": "integer", - "range": "" - } - ], - "usage": [ - "dmm.measure.configlist.storefunc(listName, function)", - "dmm.measure.configlist.storefunc(listName, function, index)" - ], - "overloads": [ - "dmm.measure.configlist.storefunc(listName, function)" - ], - "examples": [ - { - "example": "dmm.measure.configlist.create(\"MyMeasList\");dmm.measure.configlist.storefunc(\"MyMeasList\", dmm.FUNC_DC_VOLTAGE);dmm.measure.configlist.storefunc(\"MyMeasList\", dmm.FUNC_DC_TEMPERATURE, 2);", - "description": "Create a measure configuration list named MyMeasList.\n--- --Store the attributes for the DC Voltage settings in index\u00a01.\n--- --Stores attributes for the Temperature function in index 2.\n" - } - ], - "related_commands": [ - "dmm.measure.configlist.create()", - "dmm.measure.setattribute()" - ] - } - ] -} \ No newline at end of file diff --git a/main.py b/main.py index 9202ef2..8cfb8f9 100644 --- a/main.py +++ b/main.py @@ -1,232 +1,223 @@ import os import json -from Configuration import CHANNELS, HELP_FILE_FOLDER_PATH, MODEL_NUMBER, OUTPUT_FOLDER_PATH +import shutil +import sys +from Configuration import Confiurations from ParserGeneric import HelperFunctions import copy -description_list = [] -setblock_list =[] +def parse_web_help_files(webHelpFoldersDir): -for filename in os.listdir(HELP_FILE_FOLDER_PATH): - if filename.endswith('.htm'): - #if filename.endswith('.html'): # 70xB - fname = os.path.join(HELP_FILE_FOLDER_PATH,filename) - soup = HelperFunctions.Parser(fname) - try: - #command= soup.find_all("h2").pop(0).get_text() - command= soup.find_all("h2","heading2-icl").pop(0).get_text().strip() - except: - command= "" - - if command == "*CLS" or command == "*ESR?" or command == "*OPC" or command == "*OPC?" or command == "*ESE" or command == "*ESE?" or command == "*IDN?" or command == "*LANG?" or command == "*LANG" or command == "*RST" or command == "*SRE?" or command == "*SRE" or command == "*STB?" or command == "*TRG" or command == "*TST?" or command == "*WAI": - continue - - """ txt = filename+ " -> " + x + "\n" - n = text_file.write(txt) """ - - """ if "*" in command: - txt = filename + " -> " + command + "\n" - n = star_text_file.write(txt) """ + output_folder = "data" + if os.path.exists(output_folder): + shutil.rmtree(Confiurations.OUTPUT_FOLDER_PATH) + os.makedirs(output_folder) + else: + os.makedirs(output_folder) - if "*" in command and "slot" in command:#available in 37xx model eg. slot[slot].endchannel.* - star_command = ["amps","analogoutput","digitalio","isolated","totalizer","voltage"] - star_desc = [ - "Channel supports amperage measurements", - "Channel supports a digital analog output (DAC)", - "Channel supports digital inputs and outputs", - "Channel supports isolated channels", - "Channel supports totalizer channels", - "Channel supports voltage or two-wire measurements" - ] - for x in range(0, 6): - explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( - command,soup) - - explanation += star_desc[x] - name = command.replace("*",star_command[x]) - record = HelperFunctions.get_record( - name, filename, command_type, default_value, explanation, details, param_info, usage, examples, related_commands, tsp_link) - - description_list.append(record) - elif "*" in command and "localnode" in command:#available in 70xb model eg. localnode.define.* - localnode_star_command = ["MAX_TIMERS","MAX_DIO_LINES","MAX_TSPLINK_TRIGS","MAX_BLENDERS","MAX_BLENDER_INPUTS","MAX_LAN_TRIGS","MAX_CHANNEL_TRIGS"] - for x in range(0, 7): - explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( - command, soup) - - name = command.replace("*",localnode_star_command[x]) + for dir in os.listdir(webHelpFoldersDir): + try: + folder = os.path.join(webHelpFoldersDir, dir) + if os.path.isdir(folder): + if dir.split("_")[1] in Confiurations.SUPPORTED_MODELS: + Confiurations.HELP_FILE_FOLDER_PATH = folder + if str(dir).find("Commands_26XX")!= -1: + for model in Confiurations.MODEL_2600B_CHANNELS.keys(): + Confiurations.MODEL_NUMBER = model + Confiurations.CHANNELS = Confiurations.MODEL_2600B_CHANNELS.get(model) + parse() + else: + Confiurations.MODEL_NUMBER = dir.split("_")[1] + parse() + else: + print(dir.split("_")[1]+ " is not supported") - record = HelperFunctions.get_record( - name, filename, command_type, default_value, explanation, details, param_info, usage, examples, related_commands, tsp_link) + except Exception as E: + print(E) + - description_list.append(record) - elif "*" in command and "status" in command:#available in 26xx model eg. status.operation.* - status_star_command = ["condition","enable","event","ntr","ptr"] - status_star_command_type = ["Attribute (R)", "Attribute (RW)", "Attribute (R)", "Attribute (RW)", "Attribute (RW)"] +def parse(): + description_list = [] + + for filename in os.listdir(Confiurations.HELP_FILE_FOLDER_PATH): + if filename.endswith('.htm'): + #if filename.endswith('.html'): # 70xB + fname = os.path.join(Confiurations.HELP_FILE_FOLDER_PATH,filename) + soup = HelperFunctions.Parser(fname) + try: + #command= soup.find_all("h2").pop(0).get_text() + command= soup.find_all("h2","heading2-icl").pop(0).get_text().strip() + except: + command= "" + + if command == "*CLS" or command == "*ESR?" or command == "*OPC" or command == "*OPC?" or command == "*ESE" or command == "*ESE?" or command == "*IDN?" or command == "*LANG?" or command == "*LANG" or command == "*RST" or command == "*SRE?" or command == "*SRE" or command == "*STB?" or command == "*TRG" or command == "*TST?" or command == "*WAI": + continue + + """ txt = filename+ " -> " + x + "\n" + n = text_file.write(txt) """ + + """ if "*" in command: + txt = filename + " -> " + command + "\n" + n = star_text_file.write(txt) """ - channel = [""] + if "*" in command and "slot" in command:#available in 37xx model eg. slot[slot].endchannel.* + star_command = ["amps","analogoutput","digitalio","isolated","totalizer","voltage"] + star_desc = [ + "Channel supports amperage measurements", + "Channel supports a digital analog output (DAC)", + "Channel supports digital inputs and outputs", + "Channel supports isolated channels", + "Channel supports totalizer channels", + "Channel supports voltage or two-wire measurements" + ] + for x in range(0, 6): + explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( + command,soup) + + explanation += star_desc[x] + name = command.replace("*",star_command[x]) - if "smuX" in command: - channel = CHANNELS + record = HelperFunctions.get_record( + name, filename, command_type, default_value, explanation, details, param_info, usage, examples, related_commands, tsp_link) - for ch in channel: - for x in range(0, 5): + description_list.append(record) + elif "*" in command and "localnode" in command:#available in 70xb model eg. localnode.define.* + localnode_star_command = ["MAX_TIMERS","MAX_DIO_LINES","MAX_TSPLINK_TRIGS","MAX_BLENDERS","MAX_BLENDER_INPUTS","MAX_LAN_TRIGS","MAX_CHANNEL_TRIGS"] + for x in range(0, 7): explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( command, soup) - - command_type = status_star_command_type[x] - name = command.replace("*",status_star_command[x]).replace("X", ch) + + name = command.replace("*",localnode_star_command[x]) record = HelperFunctions.get_record( - name,filename, command_type, default_value, explanation, details, param_info, usage, examples, related_commands, "Yes") # make tsplink as yes for all status* command since its getting wrong value in parsing - + name, filename, command_type, default_value, explanation, details, param_info, usage, examples, related_commands, tsp_link) + description_list.append(record) + elif "*" in command and "status" in command:#available in 26xx model eg. status.operation.* + status_star_command = ["condition","enable","event","ntr","ptr"] + status_star_command_type = ["Attribute (R)", "Attribute (RW)", "Attribute (R)", "Attribute (RW)", "Attribute (RW)"] + + channel = [""] - elif "smuX" in command and "Y" not in command: - explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( - command,soup) - for x in CHANNELS: - name = command.replace("X", x) - usage1 = [sig.replace("X", x) for sig in usage] - parameter = copy.deepcopy(param_info) - for parm in parameter: - for key in parm: - if parm[key] == 'X' or parm[key] =='Y': - continue - else: - parm[key] = parm[key].replace("X",x) - """ temp_enum_datas = deepcopy(enum_datas) - for enum_data in temp_enum_datas: - new_enum = enum_data.get('enum').replace("X",x) - enum_data['enum'] = new_enum """ - record = HelperFunctions.get_record( - name,filename, command_type, default_value, explanation, details, parameter, usage1, examples, related_commands,tsp_link) - - description_list.append(record) - - elif "smuX" in command and "Y" in command: - #if "smuX.measure.rel.enableY" in command: - explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( - command,soup) - y_param_details = HelperFunctions.get_Y_param_options( - command, param_info, command_type, usage) - - usage_orignal = copy.deepcopy(usage) - - for x in CHANNELS: - for y in y_param_details: - if "iv" in y: - usage = [sig for sig in usage_orignal if "iv" in sig] - else: - usage = [sig for sig in usage_orignal if "Y" in sig] + if "smuX" in command: + channel = Confiurations.CHANNELS + + for ch in channel: + for x in range(0, 5): + explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( + command, soup) + + command_type = status_star_command_type[x] + name = command.replace("*",status_star_command[x]).replace("X", ch) - name = command.replace("Y", y).replace("X", x) - usage1 = [sig.replace("Y", y).replace("X", x) - for sig in usage] + record = HelperFunctions.get_record( + name,filename, command_type, default_value, explanation, details, param_info, usage, examples, related_commands, "Yes") # make tsplink as yes for all status* command since its getting wrong value in parsing + + description_list.append(record) + + elif "smuX" in command and "Y" not in command: + explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( + command,soup) + for x in Confiurations.CHANNELS: + name = command.replace("X", x) + usage1 = [sig.replace("X", x) for sig in usage] parameter = copy.deepcopy(param_info) for parm in parameter: - for key in parm: - if parm[key] == 'X' or parm[key] =='Y': - continue - else: - parm[key] = parm[key].replace("X",x).replace("Y",y) + for key in parm: + if parm[key] == 'X' or parm[key] =='Y': + continue + else: + parm[key] = parm[key].replace("X",x) """ temp_enum_datas = deepcopy(enum_datas) for enum_data in temp_enum_datas: - new_enum = enum_data.get('enum').replace("X",x) - enum_data['enum'] = new_enum """ + new_enum = enum_data.get('enum').replace("X",x) + enum_data['enum'] = new_enum """ record = HelperFunctions.get_record( - name, filename, command_type, default_value, explanation, details, parameter, usage1, examples, related_commands,tsp_link) - # replace 'Y' with i,v,p,r in signature and uses and overloads and append recoed - description_list.append(record) - elif "smu.source.xlimit" in command: # this command is having i,v as parameter that needs to handle sperately - explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( - command,soup) - for x in ["i", "v"]: - name = command.replace("x", x) - usage1 = [sig.replace("x", x) for sig in usage] - parameter = copy.deepcopy(param_info) - record = HelperFunctions.get_record( - name,filename, command_type, default_value, explanation, details, parameter, usage1, examples, related_commands,tsp_link) - - description_list.append(record) - else: - if command != " " and command != '' """ and filename =="31093.htm" """: - try: - explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( - command, soup) - parameter = copy.deepcopy(param_info) - for parm in parameter: - for key in parm: - if "smuX" in parm[key]: - for x in CHANNELS: - parm[key] = parm[key].replace("X",x) + name,filename, command_type, default_value, explanation, details, parameter, usage1, examples, related_commands,tsp_link) + description_list.append(record) + + elif "smuX" in command and "Y" in command: + #if "smuX.measure.rel.enableY" in command: + explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( + command,soup) + y_param_details = HelperFunctions.get_Y_param_options( + command, param_info, command_type, usage) + + usage_orignal = copy.deepcopy(usage) + + for x in Confiurations.CHANNELS: + for y in y_param_details: + if "iv" in y: + usage = [sig for sig in usage_orignal if "iv" in sig] + else: + usage = [sig for sig in usage_orignal if "Y" in sig] + + name = command.replace("Y", y).replace("X", x) + usage1 = [sig.replace("Y", y).replace("X", x) + for sig in usage] + parameter = copy.deepcopy(param_info) + for parm in parameter: + for key in parm: + if parm[key] == 'X' or parm[key] =='Y': + continue + else: + parm[key] = parm[key].replace("X",x).replace("Y",y) + """ temp_enum_datas = deepcopy(enum_datas) + for enum_data in temp_enum_datas: + new_enum = enum_data.get('enum').replace("X",x) + enum_data['enum'] = new_enum """ + record = HelperFunctions.get_record( + name, filename, command_type, default_value, explanation, details, parameter, usage1, examples, related_commands,tsp_link) + # replace 'Y' with i,v,p,r in signature and uses and overloads and append recoed + description_list.append(record) + elif "smu.source.xlimit" in command: # this command is having i,v as parameter that needs to handle sperately + explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( + command,soup) + for x in ["i", "v"]: + name = command.replace("x", x) + usage1 = [sig.replace("x", x) for sig in usage] + parameter = copy.deepcopy(param_info) record = HelperFunctions.get_record( - command, filename, command_type, default_value, explanation, details, parameter, usage, examples, related_commands,tsp_link) - #if "setblock()" not in command: + name,filename, command_type, default_value, explanation, details, parameter, usage1, examples, related_commands,tsp_link) + description_list.append(record) - #else: - # setblock_list.append(record) - except Exception as e: - print(e) - print(command, "Not added to commands list\n File name: ", filename) - -#text_file.close() -#star_text_file.close() -supportedInstrumentsList = { - "2601", - "2602", - "2611", - "2612", - "2635", - "2636", - "2601A", - "2602A", - "2611A", - "2612A", - "2635A", - "2636A", - "2651A", - "2657A", - "2601B", - "2601B-PULSE", - "2602B", - "2606B", - "2611B", - "2612B", - "2635B", - "2636B", - "2604B", - "2614B", - "2634B", - "2601B-L", - "2602B-L", - "2611B-L", - "2612B-L", - "2635B-L", - "2636B-L", - "2604B-L", - "2614B-L", - "2634B-L" - } - -#description_list = {"commands": description_list, "setblock_commands":setblock_list} -description_list = {"commands": description_list} -json_obj = json.dumps(description_list, indent=4) - -with open(os.path.join(OUTPUT_FOLDER_PATH, MODEL_NUMBER+".json"), 'w', newline='') as file: - file.write(json_obj) -""" if "2600" in directory: - for item in supportedInstrumentsList: - path = output_json_file_path + '/data/'+ item + "commands.json" - #output_json_file_path = output_json_file_path + - with open(path, 'w', newline='') as file: - file.write(json_obj) - print("json file",item, "commands successfully created") -else: - output_json_file_path = output_json_file_path+'/data/'+ json_file_name - with open(output_json_file_path, 'w', newline='') as file: - file.write(json_obj) """ -print(os.path.join(OUTPUT_FOLDER_PATH, MODEL_NUMBER+".json"), "is successfully created") + else: + if command != " " and command != '' """ and filename =="31093.htm" """: + try: + explanation, usage, details, examples, related_commands, param_info, command_type, default_value, tsp_link = HelperFunctions.fetch_details( + command, soup) + parameter = copy.deepcopy(param_info) + for parm in parameter: + for key in parm: + if "smuX" in parm[key]: + for x in Confiurations.CHANNELS: + parm[key] = parm[key].replace("X",x) + + record = HelperFunctions.get_record( + command, filename, command_type, default_value, explanation, details, parameter, usage, examples, related_commands,tsp_link) + #if "setblock()" not in command: + description_list.append(record) + #else: + # setblock_list.append(record) + except Exception as e: + print(e) + print(command, "Not added to commands list\n File name: ", filename) + + description_list = {"commands": description_list} + json_obj = json.dumps(description_list, indent=4) + + with open(os.path.join(Confiurations.OUTPUT_FOLDER_PATH, Confiurations.MODEL_NUMBER+".json"), 'w', newline='') as file: + file.write(json_obj) + print(os.path.join(Confiurations.OUTPUT_FOLDER_PATH, Confiurations.MODEL_NUMBER+".json"), "is successfully created") + + +if __name__ == "__main__": + if len(sys.argv) != 2: + print("Usage: python mian.py ") + sys.exit(1) + + webHelpFoldersDir = sys.argv[1] + parse_web_help_files(webHelpFoldersDir) \ No newline at end of file diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..a2f7eaf --- /dev/null +++ b/package-lock.json @@ -0,0 +1,29 @@ +{ + "name": "@tektronix/webhelp-to-josn", + "version": "0.15.0", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "@tektronix/webhelp-to-josn", + "version": "0.15.0", + "license": "ISC", + "dependencies": { + "@tektronix/web-help-documents": "0.15.0" + } + }, + "node_modules/@tektronix/web-help-documents": { + "version": "0.15.0", + "resolved": "https://npm.pkg.github.com/download/@tektronix/web-help-documents/0.15.0/bd2ba77f6c46d7a164d642ec92b599771dc780be", + "integrity": "sha512-bG+NCkO0bKXmuZEHaclEZDszGzHf2gVBHR8X3Y7fwf0kBworwE8RojV9KGY+Qk58KTRPrW3uu5OWV2ZbbecpTA==", + "license": "ISC" + } + }, + "dependencies": { + "@tektronix/web-help-documents": { + "version": "0.15.0", + "resolved": "https://npm.pkg.github.com/download/@tektronix/web-help-documents/0.15.0/bd2ba77f6c46d7a164d642ec92b599771dc780be", + "integrity": "sha512-bG+NCkO0bKXmuZEHaclEZDszGzHf2gVBHR8X3Y7fwf0kBworwE8RojV9KGY+Qk58KTRPrW3uu5OWV2ZbbecpTA==" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..d7289f4 --- /dev/null +++ b/package.json @@ -0,0 +1,18 @@ +{ + "name": "@tektronix/webhelp-to-josn", + "version": "0.15.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/tektronix/tsp-toolkit-webhelp.git" +}, + "author": "", + "license": "ISC", + "dependencies": { + "@tektronix/web-help-documents": "0.15.0" + } +} diff --git a/requirements.txt b/requirements.txt index 907c23a..2db1ef8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,3 @@ beautifulsoup4~=4.11.1 markdownify~=0.11.6 -OrderedSet~= 4.1.0 \ No newline at end of file +ordered-set~=4.1.0 \ No newline at end of file